fix: restrict allowed characters of layout item keys

elgatosf · Feb 1, 2024 · b877cb0 · b877cb0
1 parent 85b512e
commit b877cb0
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/schemas/layout.json b/schemas/layout.json
@@ -127,6 +127,8 @@
 				"key": {
 					"type": "string",
 					"description": "Unique name used to identify the layout item. When calling `setFeedback` this value should be used as the key as part of the object that represents the feedback.",
+					"pattern": "^[A-Za-z0-9\\-_]+$",
+					"errorMessage": "String must only contain alphanumeric characters (A-z, 0-9), hyphens (-), and underscores (_)",
 					"markdownDescription": "Unique name used to identify the layout item. When calling `setFeedback` this value should be used as the key as part of the object that represents the feedback."
 				},
 				"rect": {
@@ -299,6 +301,8 @@
 				"key": {
 					"type": "string",
 					"description": "Unique name used to identify the layout item. When calling `setFeedback` this value should be used as the key as part of the object that represents the feedback.",
+					"pattern": "^[A-Za-z0-9\\-_]+$",
+					"errorMessage": "String must only contain alphanumeric characters (A-z, 0-9), hyphens (-), and underscores (_)",
 					"markdownDescription": "Unique name used to identify the layout item. When calling `setFeedback` this value should be used as the key as part of the object that represents the feedback."
 				},
 				"rect": {
@@ -479,6 +483,8 @@
 				"key": {
 					"type": "string",
 					"description": "Unique name used to identify the layout item. When calling `setFeedback` this value should be used as the key as part of the object that represents the feedback.",
+					"pattern": "^[A-Za-z0-9\\-_]+$",
+					"errorMessage": "String must only contain alphanumeric characters (A-z, 0-9), hyphens (-), and underscores (_)",
 					"markdownDescription": "Unique name used to identify the layout item. When calling `setFeedback` this value should be used as the key as part of the object that represents the feedback."
 				},
 				"rect": {
@@ -584,6 +590,8 @@
 				"key": {
 					"type": "string",
 					"description": "Unique name used to identify the layout item. When calling `setFeedback` this value should be used as the key as part of the object that represents the feedback.",
+					"pattern": "^[A-Za-z0-9\\-_]+$",
+					"errorMessage": "String must only contain alphanumeric characters (A-z, 0-9), hyphens (-), and underscores (_)",
 					"markdownDescription": "Unique name used to identify the layout item. When calling `setFeedback` this value should be used as the key as part of the object that represents the feedback."
 				},
 				"rect": {

diff --git a/src/api/layout.ts b/src/api/layout.ts
@@ -31,6 +31,10 @@ export type Layout = {
 type LayoutItemDefinition<TType extends string, TItem> = TItem & {
 	/**
 	 * Unique name used to identify the layout item. When calling `setFeedback` this value should be used as the key as part of the object that represents the feedback.
+	 * @pattern
+	 * ^[A-Za-z0-9\-_]+$
+	 * @errorMessage
+	 * String must only contain alphanumeric characters (A-z, 0-9), hyphens (-), and underscores (_)
 	 */
 	key: string;