reactioncommerce · brent-hoover · Dec 9, 2022 · Dec 9, 2022 · Dec 9, 2022 · Dec 9, 2022
diff --git a/.changeset/three-lamps-carry.md b/.changeset/three-lamps-carry.md
@@ -0,0 +1,6 @@
+---
+"@reactioncommerce/api-plugin-tags": patch
+"@reactioncommerce/api-utils": patch
+---
+
+Allow getSlug to take a second parameter of allowedChars
diff --git a/packages/api-plugin-tags/src/mutations/addTag.js b/packages/api-plugin-tags/src/mutations/addTag.js
@@ -24,13 +24,14 @@ export default async function addTag(context, input) {
     slug = slugInput;
   }
 
+  const allowedCharacters = "a-zA-Z0-9-/";
   const now = new Date();
   const tag = {
     _id: Random.id(),
     isDeleted: false,
     isTopLevel: false,
     isVisible,
-    slug: getSlug(slug),
+    slug: getSlug(slug, allowedCharacters),
     metafields,
     name,
     displayTitle,

diff --git a/packages/api-plugin-tags/src/mutations/updateTag.js b/packages/api-plugin-tags/src/mutations/updateTag.js
@@ -41,6 +41,7 @@ export default async function updateTag(context, input) {
   await context.validatePermissions(`reaction:legacy:tags:${tagId}`, "update", { shopId });
 
   const metafields = [];
+  const allowedCharacters = "a-zA-Z0-9-/";
 
   // Filter out blank meta fields
   Array.isArray(input.metafields) && input.metafields.forEach((field) => {
@@ -55,7 +56,7 @@ export default async function updateTag(context, input) {
   }
 
   const params = {
-    slug: getSlug(slug),
+    slug: getSlug(slug, allowedCharacters),
     name: input.name,
     displayTitle: input.displayTitle,
     isVisible: input.isVisible,

diff --git a/packages/api-utils/lib/getSlug.js b/packages/api-utils/lib/getSlug.js
@@ -4,14 +4,17 @@ const require = createRequire(import.meta.url);
 
 const { slugify } = require("transliteration");
 
+const standardSlug = "a-zA-Z0-9-_.~'";
+
 /**
  * @name getSlug
  * @summary Return a slugified string using "slugify" from transliteration
  * @see https://www.npmjs.com/package/transliteration
  * @memberof Utils
  * @param {String} slugString - string to slugify
+ * @param {String} [allowedChars=a-zA-Z0-9-_.~'] - specify extra characters that are not removed by slugify
  * @returns {String} slugified string
  */
-export default function getSlug(slugString) {
-  return (typeof slugString === "string" && slugify(slugString, { allowedChars: "a-zA-Z0-9-/" })) || "";
+export default function getSlug(slugString, allowedChars = standardSlug) {
+  return (typeof slugString === "string" && slugify(slugString, { allowedChars })) || "";
 }
diff --git a/packages/api-utils/lib/getSlug.test.js b/packages/api-utils/lib/getSlug.test.js
@@ -1,5 +1,7 @@
 import getSlug from "./getSlug.js";
 
+const allowedCharacters = "a-zA-Z0-9-/";
+
 it("should slugify a latin text", () => {
   const text = "This is a title";
   const slugified = getSlug(text);
@@ -8,6 +10,12 @@ it("should slugify a latin text", () => {
 
 it("should slugify a latin text with / (backslash)", () => {
   const text = "men/jacket";
-  const slugified = getSlug(text);
+  const slugified = getSlug(text, allowedCharacters);
   expect(slugified).toEqual("men/jacket");
 });
+
+it("should slugify with a mix of slash and others", () => {
+  const text = "extremely tall men/jacket";
+  const slugified = getSlug(text, allowedCharacters);
+  expect(slugified).toEqual("extremely-tall-men/jacket");
+});