@vforsh/argus-core 0.5.2 → 0.5.4

package/dist/url/queryParams.js

@@ -0,0 +1,146 @@
+/**
+ * URL rewriting shared by every command that navigates or reloads a page.
+ *
+ * `page reload --param` (which drives Chrome directly over a target's WebSocket) and
+ * `POST /navigate` (which runs inside the watcher) have to agree on what `--param foo=bar`
+ * means, and on what `/settings` resolves to. Both once lived only in the CLI, so the
+ * watcher had no way to reach them; keeping the rules here — in the dependency-free core —
+ * is what lets the two paths stay identical.
+ */
+/**
+ * Parse a single `--param key=value` argument.
+ *
+ * The value may contain `=`; only the first one separates key from value. An empty key is
+ * rejected rather than silently written as `""`.
+ */
+export const parseParamPair = (value) => {
+    const eqIdx = value.indexOf('=');
+    if (eqIdx === -1) {
+        return { error: `Invalid --param "${value}": missing "=".` };
+    }
+    const key = value.slice(0, eqIdx);
+    if (key === '') {
+        return { error: `Invalid --param "${value}": empty key.` };
+    }
+    return { key, value: value.slice(eqIdx + 1) };
+};
+/**
+ * Parse a `--params "a=b&c=d"` argument into search params.
+ *
+ * Keys and values are percent-decoded, matching what a user would have typed into an
+ * address bar. An empty string yields empty params rather than an error.
+ */
+export const parseParamsString = (value) => {
+    const params = new URLSearchParams();
+    if (value.trim() === '') {
+        return params;
+    }
+    const pairs = value.split('&');
+    for (const pair of pairs) {
+        const eqIdx = pair.indexOf('=');
+        if (eqIdx === -1) {
+            return { error: `Invalid --params "${pair}": missing "=".` };
+        }
+        const key = pair.slice(0, eqIdx);
+        if (key === '') {
+            return { error: `Invalid --params "${pair}": empty key.` };
+        }
+        params.set(decodeURIComponent(key), decodeURIComponent(pair.slice(eqIdx + 1)));
+    }
+    return params;
+};
+/** True when the URL uses a scheme whose query string Argus is willing to rewrite. */
+export const isHttpUrl = (url) => url.startsWith('http://') || url.startsWith('https://');
+/**
+ * Rewrite a URL's query string with overwrite semantics.
+ *
+ * Existing params the caller did not mention are preserved; ones it did are replaced, never
+ * appended. `params` is applied before `param` so a repeated `--param` flag wins over the
+ * bulk string when both name the same key.
+ *
+ * @param baseUrl Absolute http/https URL to rewrite.
+ * @param overrides Query overrides. When neither is present, `baseUrl` is returned unchanged.
+ * @returns The rewritten URL, or the reason the rewrite was refused (non-http scheme,
+ *   unparseable URL, malformed pair).
+ */
+export const applyQueryParams = (baseUrl, overrides) => {
+    const hasParam = (overrides.param?.length ?? 0) > 0;
+    const hasParams = overrides.params != null;
+    if (!hasParam && !hasParams) {
+        return { url: baseUrl };
+    }
+    if (!isHttpUrl(baseUrl)) {
+        return { error: `URL "${baseUrl}" is not http/https. Cannot update query params.` };
+    }
+    let parsed;
+    try {
+        parsed = new URL(baseUrl);
+    }
+    catch {
+        return { error: `Invalid URL "${baseUrl}".` };
+    }
+    if (hasParams) {
+        const fromString = parseParamsString(overrides.params);
+        if ('error' in fromString) {
+            return fromString;
+        }
+        for (const [key, value] of fromString.entries()) {
+            parsed.searchParams.set(key, value);
+        }
+    }
+    for (const pair of overrides.param ?? []) {
+        const parsedPair = parseParamPair(pair);
+        if ('error' in parsedPair) {
+            return parsedPair;
+        }
+        parsed.searchParams.set(parsedPair.key, parsedPair.value);
+    }
+    return { url: parsed.toString() };
+};
+/** A scheme followed by `//`, or any other scheme (`about:`, `data:`, `mailto:`). */
+const SCHEME_PATTERN = /^[a-zA-Z][a-zA-Z0-9+.-]*:/;
+/** `host:port` — the one shape that also matches {@link SCHEME_PATTERN} but is not a scheme. */
+const HOST_PORT_PATTERN = /^[^/?#:]+:\d+(?:[/?#]|$)/;
+/** Leading forms that are unambiguously relative to the current document. */
+const RELATIVE_PATTERN = /^[/?#]|^\.\.?(?:[/?#]|$)/;
+/**
+ * Resolve what the user typed into an absolute URL to navigate to.
+ *
+ * Three shapes reach this, and only one of them is a URL already:
+ * - relative — anything starting with `/`, `?`, `#`, `./` or `../` is resolved against
+ *   `currentUrl`. This is why resolution runs in the watcher: it owns the authoritative URL.
+ * - absolute (`https://x/y`, `about:blank`) — used verbatim.
+ * - scheme-less (`localhost:3000`, `example.com/x`) — gets `http://`, matching what a browser
+ *   address bar does.
+ *
+ * The leading character decides, deliberately: a bare token like `settings` becomes
+ * `http://settings/` rather than being guessed at, so `argus goto app /settings` and
+ * `argus goto app settings` never silently mean the same thing.
+ *
+ * @param input What the user typed. Whitespace is trimmed.
+ * @param currentUrl The page's current top-frame URL, or `null` when nothing is attached.
+ * @returns The absolute URL, or the reason it could not be resolved.
+ */
+export const resolveNavigationUrl = (input, currentUrl) => {
+    const trimmed = input.trim();
+    if (trimmed === '') {
+        return { error: 'URL must be a non-empty string.' };
+    }
+    if (RELATIVE_PATTERN.test(trimmed)) {
+        if (!currentUrl) {
+            return { error: `Cannot resolve relative URL "${trimmed}": the page has no current URL.` };
+        }
+        try {
+            return { url: new URL(trimmed, currentUrl).toString() };
+        }
+        catch {
+            return { error: `Cannot resolve "${trimmed}" against "${currentUrl}".` };
+        }
+    }
+    // `localhost:3000` also matches SCHEME_PATTERN, so the host:port shape is checked first.
+    if (HOST_PORT_PATTERN.test(trimmed) || !SCHEME_PATTERN.test(trimmed)) {
+        return { url: `http://${trimmed}` };
+    }
+    return { url: trimmed };
+};
+//# sourceMappingURL=queryParams.js.map

package/dist/url/queryParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryParams.js","sourceRoot":"","sources":["../../src/url/queryParams.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAKH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAa,EAAmB,EAAE;IAChE,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAChC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;QAClB,OAAO,EAAE,KAAK,EAAE,oBAAoB,KAAK,iBAAiB,EAAE,CAAA;IAC7D,CAAC;IACD,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;IACjC,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC;QAChB,OAAO,EAAE,KAAK,EAAE,oBAAoB,KAAK,eAAe,EAAE,CAAA;IAC3D,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAA;AAC9C,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAuC,EAAE;IACvF,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAA;IACpC,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACzB,OAAO,MAAM,CAAA;IACd,CAAC;IAED,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAC/B,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YAClB,OAAO,EAAE,KAAK,EAAE,qBAAqB,IAAI,iBAAiB,EAAE,CAAA;QAC7D,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;QAChC,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC;YAChB,OAAO,EAAE,KAAK,EAAE,qBAAqB,IAAI,eAAe,EAAE,CAAA;QAC3D,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAC/E,CAAC;IACD,OAAO,MAAM,CAAA;AACd,CAAC,CAAA;AAED,sFAAsF;AACtF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAW,EAAW,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;AAU1G;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,SAA8B,EAAuC,EAAE;IACxH,MAAM,QAAQ,GAAG,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;IACnD,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,IAAI,IAAI,CAAA;IAC1C,IAAI,CAAC,QAAQ,IAAI,CAAC,SAAS,EAAE,CAAC;QAC7B,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAA;IACxB,CAAC;IAED,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,KAAK,EAAE,QAAQ,OAAO,kDAAkD,EAAE,CAAA;IACpF,CAAC;IAED,IAAI,MAAW,CAAA;IACf,IAAI,CAAC;QACJ,MAAM,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAA;IAC1B,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,EAAE,KAAK,EAAE,gBAAgB,OAAO,IAAI,EAAE,CAAA;IAC9C,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACf,MAAM,UAAU,GAAG,iBAAiB,CAAC,SAAS,CAAC,MAAO,CAAC,CAAA;QACvD,IAAI,OAAO,IAAI,UAAU,EAAE,CAAC;YAC3B,OAAO,UAAU,CAAA;QAClB,CAAC;QACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC;YACjD,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACpC,CAAC;IACF,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,cAAc,CAAC,IAAI,CAAC,CAAA;QACvC,IAAI,OAAO,IAAI,UAAU,EAAE,CAAC;YAC3B,OAAO,UAAU,CAAA;QAClB,CAAC;QACD,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAA;IAC1D,CAAC;IAED,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAA;AAClC,CAAC,CAAA;AAED,qFAAqF;AACrF,MAAM,cAAc,GAAG,2BAA2B,CAAA;AAClD,gGAAgG;AAChG,MAAM,iBAAiB,GAAG,0BAA0B,CAAA;AACpD,6EAA6E;AAC7E,MAAM,gBAAgB,GAAG,0BAA0B,CAAA;AAEnD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAAE,UAAyB,EAAuC,EAAE;IACrH,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IAC5B,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;QACpB,OAAO,EAAE,KAAK,EAAE,iCAAiC,EAAE,CAAA;IACpD,CAAC;IAED,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACpC,IAAI,CAAC,UAAU,EAAE,CAAC;YACjB,OAAO,EAAE,KAAK,EAAE,gCAAgC,OAAO,iCAAiC,EAAE,CAAA;QAC3F,CAAC;QACD,IAAI,CAAC;YACJ,OAAO,EAAE,GAAG,EAAE,IAAI,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAA;QACxD,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,EAAE,KAAK,EAAE,mBAAmB,OAAO,cAAc,UAAU,IAAI,EAAE,CAAA;QACzE,CAAC;IACF,CAAC;IAED,yFAAyF;IACzF,IAAI,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACtE,OAAO,EAAE,GAAG,EAAE,UAAU,OAAO,EAAE,EAAE,CAAA;IACpC,CAAC;IAED,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAA;AACxB,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@vforsh/argus-core",
-	"version": "0.5.2",
+	"version": "0.5.4",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/vforsh/argus.git",