@polyv/utils-querystring 3.0.0

package/concat.d.ts

@@ -0,0 +1,18 @@
+import { IQSStringifyOptions } from './interfaces';
+/**
+ * 把指定数据序列化为查询字符串后，拼接到指定的 URL 或路径。
+ * @since 2.0.0
+ * @param url 指定的 URL 或路径，可以包含查询字符串。
+ * @param data 指定的数据。
+ * @param options 序列化选项。
+ * @returns 处理后的 URL 或路径。
+ * @example
+ * ```javascript
+ * import { concat } from '@polyv/utils-querystring';
+ * concat('https://abc.com/?a=1#hash', {
+ *   b: 2,
+ *   c: 3
+ * }); // 'https://abc.com/?a=1&b=2&c=3#hash'
+ * ```
+ */
+export declare function concat(url: string, data?: any, options?: Readonly<IQSStringifyOptions>): string;

package/index.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require("@polyv/utils-object");function t(t,n){let r=Object.create(null);if(typeof t!=`string`)return r;let i=(0,e.assignProps)({decode:decodeURIComponent},n);return t.split(`&`).forEach(function(t){if(!t)return;let n=t.split(`=`),a=n[0],o=n[1]||``;if(typeof i.decode==`function`&&(a=i.decode(a),o=i.decode(o)),(0,e.hasOwnProp)(r,a)){let e=r[a],t=Array.isArray(e)?e:[e];t.push(o),r[a]=t}else r[a]=o}),r}function n(e,t,n,r){if(n??=``,!(n===``&&r.ignoreEmpty)){if(typeof r.encode==`function`){t=r.encode(t);let e=typeof n;n=[`boolean`,`string`,`number`].indexOf(e)===-1?``:r.encode(String(n))}e.push(t+`=`+n)}}function r(e,t,r,i){r.forEach(r=>{n(e,t,r,i)})}function i(t,i){let a=(0,e.assignProps)({encode:encodeURIComponent},i),o=[],s,c;for(s in t)(0,e.hasOwnProp)(t,s)&&(c=t[s],Array.isArray(c)?r(o,s,c,a):n(o,s,c,a));return o.join(`&`)}function a(e){let t={leftContext:``},n=e.indexOf(`#`);return n!==-1&&(t.hash=e.slice(n+1),e=e.slice(0,n)),n=e.indexOf(`?`),n!==-1&&(t.search=e.slice(n+1),e=e.slice(0,n)),t.leftContext=e,t}function o(e){let t=e.leftContext;return e.search!=null&&(t+=`?`+e.search),e.hash!=null&&(t+=`#`+e.hash),t}function s(e,t,n){if(e=String(e),t==null||(t=typeof t==`string`?t.replace(/^[?&]/,``):i(t,n),!t))return e;let r=a(e),s=r.search||``;return s&&s.slice(-1)!==`&`&&(s+=`&`),s+=t,r.search=s,o(r)}function c(n,r,s){let c=a(n);if(c.search==null)return n;let l=t(c.search,s);return Object.keys(r).forEach(t=>{(0,e.hasOwnProp)(l,t)&&(l[t]=r[t])}),c.search=i(l),o(c)}exports.concat=s,exports.parse=t,exports.replace=c,exports.stringify=i;

package/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 调用入口。
+ * @packageDocumentation
+ */
+export type { IQSParseOptions, IQSReplaceOptions, IQSStringifyOptions, } from './interfaces';
+export { parse } from './parse';
+export { stringify } from './stringify';
+export { concat } from './concat';
+export { replace } from './replace';

package/index.js

@@ -0,0 +1,70 @@
+import { assignProps as e, hasOwnProp as t } from "@polyv/utils-object";
+//#region src/parse.ts
+function n(n, r) {
+	let i = Object.create(null);
+	if (typeof n != "string") return i;
+	let a = e({ decode: decodeURIComponent }, r);
+	return n.split("&").forEach(function(e) {
+		if (!e) return;
+		let n = e.split("="), r = n[0], o = n[1] || "";
+		if (typeof a.decode == "function" && (r = a.decode(r), o = a.decode(o)), t(i, r)) {
+			let e = i[r], t = Array.isArray(e) ? e : [e];
+			t.push(o), i[r] = t;
+		} else i[r] = o;
+	}), i;
+}
+//#endregion
+//#region src/stringify.ts
+function r(e, t, n, r) {
+	if (n ??= "", !(n === "" && r.ignoreEmpty)) {
+		if (typeof r.encode == "function") {
+			t = r.encode(t);
+			let e = typeof n;
+			n = [
+				"boolean",
+				"string",
+				"number"
+			].indexOf(e) === -1 ? "" : r.encode(String(n));
+		}
+		e.push(t + "=" + n);
+	}
+}
+function i(e, t, n, i) {
+	n.forEach((n) => {
+		r(e, t, n, i);
+	});
+}
+function a(n, a) {
+	let o = e({ encode: encodeURIComponent }, a), s = [], c, l;
+	for (c in n) t(n, c) && (l = n[c], Array.isArray(l) ? i(s, c, l, o) : r(s, c, l, o));
+	return s.join("&");
+}
+//#endregion
+//#region src/internal/util.ts
+function o(e) {
+	let t = { leftContext: "" }, n = e.indexOf("#");
+	return n !== -1 && (t.hash = e.slice(n + 1), e = e.slice(0, n)), n = e.indexOf("?"), n !== -1 && (t.search = e.slice(n + 1), e = e.slice(0, n)), t.leftContext = e, t;
+}
+function s(e) {
+	let t = e.leftContext;
+	return e.search != null && (t += "?" + e.search), e.hash != null && (t += "#" + e.hash), t;
+}
+//#endregion
+//#region src/concat.ts
+function c(e, t, n) {
+	if (e = String(e), t == null || (t = typeof t == "string" ? t.replace(/^[?&]/, "") : a(t, n), !t)) return e;
+	let r = o(e), i = r.search || "";
+	return i && i.slice(-1) !== "&" && (i += "&"), i += t, r.search = i, s(r);
+}
+//#endregion
+//#region src/replace.ts
+function l(e, r, i) {
+	let c = o(e);
+	if (c.search == null) return e;
+	let l = n(c.search, i);
+	return Object.keys(r).forEach((e) => {
+		t(l, e) && (l[e] = r[e]);
+	}), c.search = a(l), s(c);
+}
+//#endregion
+export { c as concat, n as parse, l as replace, a as stringify };

package/interfaces.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 接口。
+ * @packageDocumentation
+ */
+/**
+ * 解析查询字符串的选项。
+ */
+export interface IQSParseOptions {
+    /**
+     * 键和值的解码函数，默认为 decodeURIComponent。
+     */
+    decode?: (content: string) => string;
+}
+/**
+ * 序列化查询字符串的选项。
+ */
+export interface IQSStringifyOptions {
+    /**
+     * 键和值的编码函数，默认为 encodeURIComponent。
+     */
+    encode?: (content: string) => string;
+    /**
+     * 序列化参数时是否忽略空值（null、undefined、空字符串）参数，默认为 false。
+     */
+    ignoreEmpty?: boolean;
+}
+/**
+ * 替换查询字符串的选项。
+ */
+export interface IQSReplaceOptions extends IQSParseOptions, IQSStringifyOptions {
+}

package/internal/util.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 内部工具函数。
+ * @packageDocumentation
+ * @internal
+ */
+/**
+ * URL 切割结果。
+ */
+export interface IURLSplittingResult {
+    /**
+     * 切割后的左侧上下文，包括 URL 的协议、域名、路径。
+     */
+    leftContext: string;
+    /**
+     * 查询参数。
+     */
+    search?: string;
+    /**
+     * 锚点。
+     */
+    hash?: string;
+}
+/**
+ * 切割 URL 或路径。
+ * @param url 要切割的 URL 或路径。
+ * @returns 切割结果。
+ */
+export declare function splitURL(url: string): IURLSplittingResult;
+/**
+ * 根据切割结果还原 URL 或路径。
+ * @param result 切割结果。
+ * @returns 还原后的 URL 或路径。
+ */
+export declare function joinURL(result: IURLSplittingResult): string;

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@polyv/utils-querystring",
+  "version": "3.0.0",
+  "description": "Query string utilities for Polyv frontend development.",
+  "type": "module",
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "miniprogram": "./",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "require": "./index.cjs"
+    }
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "@polyv/utils-object": "3.0.0"
+  }
+}

package/parse.d.ts

@@ -0,0 +1,16 @@
+import { IQSParseOptions } from './interfaces';
+/**
+ * 把查询字符串解析为键值对集合。
+ * @param str 查询字符串。
+ * @param options 解析选项。
+ * @returns 键值对集合。
+ * @example
+ * ```javascript
+ * import { parse } from '@polyv/utils-querystring';
+ * parse('id=0&str=hello'); // { id: '0', str: 'hello' }
+ * parse('id=0&id=1'); // { id: ['0', '1'] }
+ * ```
+ */
+export declare function parse(str: string, options?: Readonly<IQSParseOptions>): {
+    [key: string]: string | string[];
+};

package/replace.d.ts

@@ -0,0 +1,16 @@
+import { IQSReplaceOptions } from './interfaces';
+/**
+ * 替换查询字符串中指定参数的值。
+ * @since 2.0.0
+ * @param url 包含查询字符串的 URL 或路径。
+ * @param newData 要替换的参数及其替换后的值，以键值对方式传参。
+ * @param options 操作选项。
+ * @returns 已替换参数值的查询字符串。
+ * @example
+ * ```javascript
+ * import { replace } from '@polyv/utils-querystring';
+ * replace('abc?a=1&b=2', { a: 2 }); // 'abc?a=2&b=2'
+ * replace('abc?a=1&b=2', { c: 3 }); // 'abc?a=1&b=2'
+ * ```
+ */
+export declare function replace(url: string, newData: any, options?: Readonly<IQSReplaceOptions>): string;

package/stringify.d.ts

@@ -0,0 +1,14 @@
+import { IQSStringifyOptions } from './interfaces';
+/**
+ * 把键值对序列化为查询字符串。
+ * @param data 键值对。
+ * @param options 序列化选项。
+ * @returns 序列化结果。
+ * @example
+ * ```javascript
+ * import { stringify } from '@polyv/utils-querystring';
+ * stringify({ id: '0', str: 'hello' }); // 'id=0&str=hello'
+ * stringify({ id: ['0', '1'] }); // 'id=0&id=1'
+ * ```
+ */
+export declare function stringify(data: any, options?: Readonly<IQSStringifyOptions>): string;