Merge pull request #225 from port-labs/feat/add-pattern-jq-query-to-string-props

verify contribution from hedinasr

Author: MPTG94

action.test

@@ -675,6 +675,7 @@ Optional:
 - `max_length` (Number) The max length of the string property
 - `min_length` (Number) The min length of the string property
 - `pattern` (String) The pattern of the string property
+- `pattern_jq_query` (String) The pattern jq query of the string property. This field accepts a JQ expression to dynamically generate either a regex pattern (as a string) or a list of allowed values (as an array). Cannot be used with `pattern`. Empty values are not allowed. Examples: `"if .env == \"prod\" then \"^[a-z]+$\" else \"^[a-zA-Z]+$\" end"` for dynamic regex patterns, or `"[\"value1\", \"value2\"]"` for a fixed list of allowed values.
 - `required` (Boolean) Whether the property is required, by default not required, this property can't be set at the same time if `required_jq_query` is set, and only supports true as value
 - `sort` (Attributes) How to sort entities when in the self service action form in the UI (see [below for nested schema](#nestedatt--self_service_trigger--user_properties--string_props--sort))
 - `title` (String) The title of the property

docs/resources/port_action.md

@@ -0,0 +1,44 @@
+# Pattern JQ Query Examples
+
+This example demonstrates how to use the `pattern_jq_query` attribute in different ways:
+
+## Ways to Use `pattern_jq_query`
+
+The `pattern_jq_query` field accepts a JQ expression that gets evaluated by the Port API at runtime. This JQ expression can produce:
+
+### 1. A Regex Pattern
+
+```hcl
+pattern_jq_query = "if .environment == \"production\" then \"^[a-z][a-z0-9-]{3,20}$\" else \"^[a-z][a-z0-9-]{2,10}$\" end"
+```
+
+This approach generates a regex pattern dynamically based on context. It works like the static `pattern` field but allows the regex to change based on other properties.
+
+### 2. A List of Allowed Values
+
+```hcl
+pattern_jq_query = "if .team == \"platform\" then [\"dev\", \"staging\", \"production\"] else [\"dev\", \"staging\"] end"
+```
+
+This approach generates a list of allowed values dynamically. It's similar to an enum but with values that can change based on context.
+
+### 3. Direct JSON Array of Allowed Values
+
+```hcl
+pattern_jq_query = "[\"value1\", \"value2\", \"value3\"]"
+```
+
+This simpler format can be used to specify a fixed list of allowed values directly.
+
+## Important Notes
+
+- You cannot use both `pattern` and `pattern_jq_query` at the same time on the same property
+- The JQ query is evaluated at runtime by Port
+- The context available to the JQ expression depends on where the pattern is being used (entity context, action context, etc.)
+- For regex patterns, make sure to escape special characters properly
+
+## How to Use
+
+1. Choose which approach is most appropriate for your use case
+2. Write a JQ expression or JSON array as needed
+3. Apply the pattern validation to the appropriate string property in your action definition 

examples/resources/port_action/pattern_jq_query/README.md

@@ -0,0 +1,73 @@
+# This example demonstrates different ways to use pattern_jq_query
+
+# Example 1: Using pattern_jq_query to dynamically generate a regex pattern
+resource "port_action" "regex_pattern_example" {
+  title      = "Create Service"
+  identifier = "create_service"
+  self_service_trigger = {
+    operation           = "CREATE"
+    blueprint_identifier = "service"
+    user_properties = {
+      string_props = {
+        service_name = {
+          title      = "Service Name"
+          # Dynamic regex pattern based on context
+          pattern_jq_query = "if .environment == \"production\" then \"^[a-z][a-z0-9-]{3,20}$\" else \"^[a-z][a-z0-9-]{2,10}$\" end"
+          description = "Name of the service (lowercase, numbers, hyphens)"
+        }
+      }
+    }
+  }
+  description = "Create a new service"
+  webhook_method = {
+    url = "https://api.example.com/create-service"
+  }
+}
+
+# Example 2: Using pattern_jq_query to dynamically generate a list of allowed values
+resource "port_action" "allowed_values_example" {
+  title      = "Deploy To Environment"
+  identifier = "deploy_to_env"
+  self_service_trigger = {
+    operation           = "DAY-2"
+    blueprint_identifier = "microservice"
+    user_properties = {
+      string_props = {
+        target_environment = {
+          title      = "Target Environment"
+          # Dynamic allowed values based on context
+          pattern_jq_query = "if .team == \"platform\" then [\"dev\", \"staging\", \"production\"] else [\"dev\", \"staging\"] end"
+          description = "Environment to deploy to (platform team can deploy to production)"
+        }
+      }
+    }
+  }
+  description = "Deploy service to environment"
+  webhook_method = {
+    url = "https://api.example.com/deploy"
+  }
+}
+
+# Example 3: Using pattern_jq_query with a direct JSON array of allowed values
+resource "port_action" "direct_array_example" {
+  title      = "Select Region"
+  identifier = "select_region"
+  self_service_trigger = {
+    operation           = "CREATE"
+    blueprint_identifier = "deployment"
+    user_properties = {
+      string_props = {
+        region = {
+          title      = "Region"
+          # Direct JSON array of allowed values
+          pattern_jq_query = "[\"us-east-1\", \"us-west-1\", \"eu-west-1\", \"ap-northeast-1\"]"
+          description = "AWS region for deployment"
+        }
+      }
+    }
+  }
+  description = "Select deployment region"
+  webhook_method = {
+    url = "https://api.example.com/select-region"
+  }
+} 

examples/resources/port_action/pattern_jq_query/main.tf

@@ -88,7 +88,7 @@ type (
 		Minimum            *float64            `json:"minimum,omitempty"`
 		Description        *string             `json:"description,omitempty"`
 		Blueprint          *string             `json:"blueprint,omitempty"`
-		Pattern            *string             `json:"pattern,omitempty"`
+		Pattern            any                 `json:"pattern,omitempty"`
 		Enum               any                 `json:"enum,omitempty"`
 		Spec               *string             `json:"spec,omitempty"`
 		SpecAuthentication *SpecAuthentication `json:"specAuthentication,omitempty"`

internal/cli/models.go

@@ -30,17 +30,18 @@ type StringPropModel struct {
 	Visible        types.Bool    `tfsdk:"visible"`
 	VisibleJqQuery types.String  `tfsdk:"visible_jq_query"`
 
-	Default     types.String       `tfsdk:"default"`
-	Blueprint   types.String       `tfsdk:"blueprint"`
-	Format      types.String       `tfsdk:"format"`
-	MaxLength   types.Int64        `tfsdk:"max_length"`
-	MinLength   types.Int64        `tfsdk:"min_length"`
-	Pattern     types.String       `tfsdk:"pattern"`
-	Enum        types.List         `tfsdk:"enum"`
-	EnumColors  types.Map          `tfsdk:"enum_colors"`
-	EnumJqQuery types.String       `tfsdk:"enum_jq_query"`
-	Encryption  types.String       `tfsdk:"encryption"`
-	Sort        *EntitiesSortModel `tfsdk:"sort"`
+	Default        types.String       `tfsdk:"default"`
+	Blueprint      types.String       `tfsdk:"blueprint"`
+	Format         types.String       `tfsdk:"format"`
+	MaxLength      types.Int64        `tfsdk:"max_length"`
+	MinLength      types.Int64        `tfsdk:"min_length"`
+	Pattern        types.String       `tfsdk:"pattern"`
+	PatternJqQuery types.String       `tfsdk:"pattern_jq_query"`
+	Enum           types.List         `tfsdk:"enum"`
+	EnumColors     types.Map          `tfsdk:"enum_colors"`
+	EnumJqQuery    types.String       `tfsdk:"enum_jq_query"`
+	Encryption     types.String       `tfsdk:"encryption"`
+	Sort           *EntitiesSortModel `tfsdk:"sort"`
 }
 
 // StringPropValidationModel is a model used for the validation of StringPropModel resources