@gjsify/querystring 0.0.4 → 0.1.0

package/README.md

@@ -1,7 +1,34 @@
 # @gjsify/querystring
 
-Node.js querystring module for Gjs
+GJS implementation of the Node.js `querystring` module. Provides parse and stringify.
+
+Part of the [gjsify](https://github.com/gjsify/gjsify) project — Node.js and Web APIs for GJS (GNOME JavaScript).
+
+## Installation
+
+```bash
+npm install @gjsify/querystring
+# or
+yarn add @gjsify/querystring
+```
+
+## Usage
+
+```typescript
+import { parse, stringify } from '@gjsify/querystring';
+
+const obj = parse('foo=bar&baz=qux');
+console.log(obj); // { foo: 'bar', baz: 'qux' }
+
+const str = stringify({ name: 'test', value: '123' });
+console.log(str); // 'name=test&value=123'
+```
 
 ## Inspirations and credits
- * https://github.com/SpainTrain/querystring-es3
- * https://github.com/denoland/deno_std/blob/main/node/querystring.ts
+
+- https://github.com/SpainTrain/querystring-es3
+- https://github.com/denoland/deno_std/blob/main/node/querystring.ts
+
+## License
+
+MIT

package/lib/esm/index.js

@@ -1,4 +1,4 @@
-import { Buffer } from "buffer";
+import { Buffer } from "node:buffer";
 import { NodeURIError } from "./error.js";
 const hexTable = new Array(256);
 for (let i = 0; i < 256; ++i) {
@@ -6,23 +6,19 @@ for (let i = 0; i < 256; ++i) {
 }
 function encodeStr(str, noEscapeTable, hexTable2) {
   const len = str.length;
-  if (len === 0)
-    return "";
+  if (len === 0) return "";
   let out = "";
   let lastPos = 0;
   for (let i = 0; i < len; i++) {
     let c = str.charCodeAt(i);
     if (c < 128) {
-      if (noEscapeTable[c] === 1)
-        continue;
-      if (lastPos < i)
-        out += str.slice(lastPos, i);
+      if (noEscapeTable[c] === 1) continue;
+      if (lastPos < i) out += str.slice(lastPos, i);
       lastPos = i + 1;
       out += hexTable2[c];
       continue;
     }
-    if (lastPos < i)
-      out += str.slice(lastPos, i);
+    if (lastPos < i) out += str.slice(lastPos, i);
     if (c < 2048) {
       lastPos = i + 1;
       out += hexTable2[192 | c >> 6] + hexTable2[128 | c & 63];
@@ -34,17 +30,14 @@ function encodeStr(str, noEscapeTable, hexTable2) {
       continue;
     }
     ++i;
-    if (i >= len)
-      throw new ERR_INVALID_URI();
+    if (i >= len) throw new ERR_INVALID_URI();
     const c2 = str.charCodeAt(i) & 1023;
     lastPos = i + 1;
     c = 65536 + ((c & 1023) << 10 | c2);
     out += hexTable2[240 | c >> 18] + hexTable2[128 | c >> 12 & 63] + hexTable2[128 | c >> 6 & 63] + hexTable2[128 | c & 63];
   }
-  if (lastPos === 0)
-    return str;
-  if (lastPos < len)
-    return out + str.slice(lastPos);
+  if (lastPos === 0) return str;
+  if (lastPos < len) return out + str.slice(lastPos);
   return out;
 }
 class ERR_INVALID_URI extends NodeURIError {
@@ -342,10 +335,16 @@ function charCodes(str) {
 }
 function addKeyVal(obj, key, value, keyEncoded, valEncoded, decode2) {
   if (key.length > 0 && keyEncoded) {
-    key = decode2(key);
+    try {
+      key = decode2(key);
+    } catch {
+    }
   }
   if (value.length > 0 && valEncoded) {
-    value = decode2(value);
+    try {
+      value = decode2(value);
+    } catch {
+    }
   }
   if (obj[key] === void 0) {
     obj[key] = value;
@@ -673,8 +672,7 @@ function stringify(obj, sep, eq, options) {
       ks += eq;
       if (Array.isArray(v)) {
         const vlen = v.length;
-        if (vlen === 0)
-          continue;
+        if (vlen === 0) continue;
         if (fields) {
           fields += sep;
         }
@@ -1013,7 +1011,7 @@ function qsUnescape(s) {
   }
 }
 const unescape = qsUnescape;
-var src_default = {
+var index_default = {
   parse,
   stringify,
   decode,
@@ -1025,7 +1023,7 @@ var src_default = {
 export {
   ERR_INVALID_URI,
   decode,
-  src_default as default,
+  index_default as default,
   encode,
   escape,
   parse,

package/lib/types/error.d.ts

@@ -0,0 +1,12 @@
+/**
+ * All error instances in Node have additional methods and properties
+ * This export class is meant to be extended by these instances abstracting native JS error instances
+ */
+export declare class NodeErrorAbstraction extends Error {
+    code: string;
+    constructor(name: string, code: string, message: string);
+    toString(): string;
+}
+export declare class NodeURIError extends NodeErrorAbstraction implements URIError {
+    constructor(code: string, message: string);
+}

package/lib/types/index.d.ts

@@ -0,0 +1,86 @@
+import type { ParsedUrlQuery } from 'node:querystring';
+import { Buffer } from "node:buffer";
+import { NodeURIError } from "./error.js";
+export declare class ERR_INVALID_URI extends NodeURIError {
+    constructor();
+}
+/**
+ * Alias of querystring.parse()
+ * @legacy
+ */
+export declare const decode: typeof parse;
+/**
+ * Alias of querystring.stringify()
+ * @legacy
+ */
+export declare const encode: typeof stringify;
+/**
+ * replaces encodeURIComponent()
+ * @see https://www.ecma-international.org/ecma-262/5.1/#sec-15.1.3.4
+ */
+declare function qsEscape(str: unknown): string;
+/**
+ * Performs URL percent-encoding on the given `str` in a manner that is optimized for the specific requirements of URL query strings.
+ * Used by `querystring.stringify()` and is generally not expected to be used directly.
+ * It is exported primarily to allow application code to provide a replacement percent-encoding implementation if necessary by assigning `querystring.escape` to an alternative function.
+ * @legacy
+ * @see Tested in `test-querystring-escape.js`
+ */
+export declare const escape: typeof qsEscape;
+export type { ParsedUrlQuery };
+interface ParseOptions {
+    /** The function to use when decoding percent-encoded characters in the query string. */
+    decodeURIComponent?: (string: string) => string;
+    /** Specifies the maximum number of keys to parse. */
+    maxKeys?: number;
+}
+/**
+ * Parses a URL query string into a collection of key and value pairs.
+ * @param str The URL query string to parse
+ * @param sep The substring used to delimit key and value pairs in the query string. Default: '&'.
+ * @param eq The substring used to delimit keys and values in the query string. Default: '='.
+ * @param options The parse options
+ * @param options.decodeURIComponent The function to use when decoding percent-encoded characters in the query string. Default: `querystring.unescape()`.
+ * @param options.maxKeys Specifies the maximum number of keys to parse. Specify `0` to remove key counting limitations. Default: `1000`.
+ * @legacy
+ * @see Tested in test-querystring.js
+ */
+export declare function parse(str: string, sep?: string, eq?: string, { decodeURIComponent, maxKeys }?: ParseOptions): ParsedUrlQuery;
+interface StringifyOptions {
+    /** The function to use when converting URL-unsafe characters to percent-encoding in the query string. */
+    encodeURIComponent: (string: string) => string;
+}
+/**
+ * Produces a URL query string from a given obj by iterating through the object's "own properties".
+ * @param obj The object to serialize into a URL query string.
+ * @param sep The substring used to delimit key and value pairs in the query string. Default: '&'.
+ * @param eq The substring used to delimit keys and values in the query string. Default: '='.
+ * @param options The stringify options
+ * @param options.encodeURIComponent The function to use when converting URL-unsafe characters to percent-encoding in the query string. Default: `querystring.escape()`.
+ * @legacy
+ * @see Tested in `test-querystring.js`
+ */
+export declare function stringify(obj: Record<string, unknown>, sep?: string, eq?: string, options?: StringifyOptions): string;
+/**
+ * A safe fast alternative to decodeURIComponent
+ */
+export declare function unescapeBuffer(s: string, decodeSpaces?: boolean): Buffer;
+declare function qsUnescape(s: string): string;
+/**
+ * Performs decoding of URL percent-encoded characters on the given `str`.
+ * Used by `querystring.parse()` and is generally not expected to be used directly.
+ * It is exported primarily to allow application code to provide a replacement decoding implementation if necessary by assigning `querystring.unescape` to an alternative function.
+ * @legacy
+ * @see Tested in `test-querystring-escape.js`
+ */
+export declare const unescape: typeof qsUnescape;
+declare const _default: {
+    parse: typeof parse;
+    stringify: typeof stringify;
+    decode: typeof parse;
+    encode: typeof stringify;
+    unescape: typeof qsUnescape;
+    escape: typeof qsEscape;
+    unescapeBuffer: typeof unescapeBuffer;
+};
+export default _default;

package/package.json

@@ -1,31 +1,26 @@
 {
   "name": "@gjsify/querystring",
-  "version": "0.0.4",
+  "version": "0.1.0",
   "description": "Node.js querystring module for Gjs",
   "type": "module",
-  "main": "lib/cjs/index.js",
   "module": "lib/esm/index.js",
+  "types": "lib/types/index.d.ts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./lib/types/index.d.ts",
-        "default": "./lib/esm/index.js"
-      },
-      "require": {
-        "types": "./lib/types/index.d.ts",
-        "default": "./lib/cjs/index.js"
-      }
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/esm/index.js"
     }
   },
   "scripts": {
-    "clear": "rm -rf lib tsconfig.tsbuildinfo tsconfig.types.tsbuildinfo || exit 0",
-    "print:name": "echo '@gjsify/querystring'",
-    "build": "yarn print:name && yarn build:gjsify",
+    "clear": "rm -rf lib tsconfig.tsbuildinfo tsconfig.types.tsbuildinfo test.gjs.mjs test.node.mjs || exit 0",
+    "check": "tsc --noEmit",
+    "build": "yarn build:gjsify && yarn build:types",
     "build:gjsify": "gjsify build --library 'src/**/*.{ts,js}' --exclude 'src/**/*.spec.{mts,ts}' 'src/test.{mts,ts}'",
+    "build:types": "tsc",
     "build:test": "yarn build:test:gjs && yarn build:test:node",
     "build:test:gjs": "gjsify build src/test.mts --app gjs --outfile test.gjs.mjs",
     "build:test:node": "gjsify build src/test.mts --app node --outfile test.node.mjs",
-    "test": "yarn print:name && yarn build:gjsify && yarn build:test && yarn test:node && yarn test:gjs",
+    "test": "yarn build:gjsify && yarn build:test && yarn test:node && yarn test:gjs",
     "test:gjs": "gjs -m test.gjs.mjs",
     "test:node": "node test.node.mjs"
   },
@@ -35,10 +30,9 @@
     "fs"
   ],
   "devDependencies": {
-    "@gjsify/cli": "^0.0.4",
-    "@gjsify/esbuild-plugin-gjsify": "^0.0.4",
-    "@gjsify/unit": "^0.0.4",
-    "@types/inherits": "^0.0.33",
-    "@types/node": "^20.10.5"
+    "@gjsify/cli": "^0.1.0",
+    "@gjsify/unit": "^0.1.0",
+    "@types/node": "^25.5.0",
+    "typescript": "^6.0.2"
   }
 }

package/src/error.ts

@@ -1,3 +1,5 @@
+// Reference: Node.js lib/internal/errors.js — Node.js error base class
+// Reimplemented for GJS
 // TODO create module for node errors?
 
 /**