@antelopejs/dms 0.8.1 → 0.8.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## v0.8.2
+
+[compare changes](https://github.com/AntelopeJS/dms/compare/v0.8.1...v0.8.2)
+
+### 🩹 Fixes
+
+- **links:** Open a row field holding a whole URL as written ([#273](https://github.com/AntelopeJS/dms/pull/273))
+
+### ❤️ Contributors
+
+- Antony Rizzitelli <rizzitelli.antony@pm.me>
+
 ## v0.8.1
 
 [compare changes](https://github.com/AntelopeJS/dms/compare/v0.8.0...v0.8.1)

package/frontend-vue/layers/dms-core/app/utils/url-interpolation.ts

@@ -3,6 +3,10 @@ import { get } from "@nuxt/ui/runtime/utils/index.js";
 // A row field is named `{{row.<field>}}` (a dotted path reaching into it), as
 // the page's values are `{{params.X}}` / `{{query.X}}`, filled elsewhere.
 const ROW_TOKEN = /\{\{\s*row\.([^{}\s]+)\s*\}\}/g;
+// A template that is one row token and nothing else takes a whole URL from the
+// row (`{{row.invoiceUrl}}`): encoding it would turn its `/` and `?` into
+// `%2F` and `%3F`, leaving no URL to open.
+const WHOLE_ROW_TOKEN = new RegExp(`^\\s*${ROW_TOKEN.source}\\s*$`);
 
 /** Whether a template names a field of a row (`{{row.X}}`). */
 export const namesRowField = (template: string): boolean =>
@@ -30,18 +34,25 @@ function hasSafeScheme(url: string): boolean {
   return scheme === undefined || SAFE_SCHEMES.has(scheme.toLowerCase());
 }
 
+const fillRowTokens = (url: string, data: Record<string, unknown>): string => {
+  const wholeKey = WHOLE_ROW_TOKEN.exec(url)?.[1];
+  if (wholeKey !== undefined) return rowValue(data, wholeKey);
+  return url.replace(ROW_TOKEN, (_, key: string) =>
+    encodeURIComponent(rowValue(data, key)).replace(ENCODED_COLON, ":"),
+  );
+};
+
 /**
  * Fills the `{{row.field}}` tokens of a URL template with encoded row values,
- * a field the row lacks left empty. A result with a scheme other than http,
- * https or mailto comes back empty.
+ * a field the row lacks left empty. A template that is a single token takes
+ * the field as the whole URL, unencoded. A result with a scheme other than
+ * http, https or mailto comes back empty.
  */
 export const interpolateUrl = (
   url: string,
   data: Record<string, unknown>,
 ): string => {
-  const interpolated = url.replace(ROW_TOKEN, (_, key: string) =>
-    encodeURIComponent(rowValue(data, key)).replace(ENCODED_COLON, ":"),
-  );
+  const interpolated = fillRowTokens(url, data);
   return hasSafeScheme(interpolated) ? interpolated : REFUSED_URL;
 };
 

package/frontend-vue/tests/url-interpolation.test.ts

@@ -4,7 +4,10 @@ import { interpolateUrl } from "../layers/dms-core/app/utils/url-interpolation";
 describe("interpolateUrl", () => {
   it("fills row fields into the URL, encoded", () => {
     expect(
-      interpolateUrl("/items/{{row._id}}/tag/{{row.name}}", { _id: "a1", name: "a b/c" }),
+      interpolateUrl("/items/{{row._id}}/tag/{{row.name}}", {
+        _id: "a1",
+        name: "a b/c",
+      }),
     ).toBe("/items/a1/tag/a%20b%2Fc");
   });
 
@@ -27,6 +30,14 @@ describe("interpolateUrl", () => {
     );
   });
 
+  it("takes a field forming the whole URL as it is", () => {
+    const url = "https://pay.stripe.com/invoice/acct_1/x/pdf?s=ap";
+    expect(interpolateUrl("{{row.invoiceUrl}}", { invoiceUrl: url })).toBe(url);
+    expect(
+      interpolateUrl(" {{ row.links.self }} ", { links: { self: "/a/b?c=d" } }),
+    ).toBe("/a/b?c=d");
+  });
+
   it("refuses a scheme the row data brings in", () => {
     for (const site of [
       "javascript:alert(1)",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/dms",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AntelopeJS/dms.git"