NEOS-1593: Business name transformer (#2892)

nucleuscloud · Nov 3, 2024 · 9fcf422 · 9fcf422
1 parent 6242842
commit 9fcf422
Show file tree

Hide file tree

Showing 29 changed files with 3,253,267 additions and 843 deletions.
diff --git a/backend/gen/go/protos/mgmt/v1alpha1/transformer.pb.go b/backend/gen/go/protos/mgmt/v1alpha1/transformer.pb.go
diff --git a/backend/protos/mgmt/v1alpha1/transformer.proto b/backend/protos/mgmt/v1alpha1/transformer.proto
@@ -138,6 +138,7 @@ enum TransformerSource {
   TRANSFORMER_SOURCE_GENERATE_COUNTRY = 46;
   // NeosyncCloud/Enterprise only transformer for anonymizing PII Text
   TRANSFORMER_SOURCE_TRANSFORM_PII_TEXT = 47;
+  TRANSFORMER_SOURCE_GENERATE_BUSINESS_NAME = 48;
 }
 
 enum TransformerDataType {
@@ -217,6 +218,7 @@ message TransformerConfig {
     GenerateCountry generate_country_config = 43;
     // NeosyncCloud/Enterprise only transformer for anonymizing PII Text
     TransformPiiText transform_pii_text_config = 44;
+    GenerateBusinessName generate_business_name_config = 45;
   }
 }
 
@@ -511,6 +513,8 @@ message GetTransformPiiEntitiesResponse {
   repeated string entities = 1;
 }
 
+message GenerateBusinessName {}
+
 service TransformersService {
   rpc GetSystemTransformers(GetSystemTransformersRequest) returns (GetSystemTransformersResponse) {}
   rpc GetSystemTransformerBySource(GetSystemTransformerBySourceRequest) returns (GetSystemTransformerBySourceResponse) {}

diff --git a/backend/services/mgmt/v1alpha1/transformers-service/system_transformers.go b/backend/services/mgmt/v1alpha1/transformers-service/system_transformers.go
@@ -626,6 +626,19 @@ var (
 				},
 			},
 		},
+		{
+			Name:              "Generate Business Name",
+			Description:       "Generates a random business name.",
+			DataType:          mgmtv1alpha1.TransformerDataType_TRANSFORMER_DATA_TYPE_STRING,
+			DataTypes:         []mgmtv1alpha1.TransformerDataType{mgmtv1alpha1.TransformerDataType_TRANSFORMER_DATA_TYPE_STRING, mgmtv1alpha1.TransformerDataType_TRANSFORMER_DATA_TYPE_NULL},
+			SupportedJobTypes: []mgmtv1alpha1.SupportedJobType{mgmtv1alpha1.SupportedJobType_SUPPORTED_JOB_TYPE_GENERATE, mgmtv1alpha1.SupportedJobType_SUPPORTED_JOB_TYPE_SYNC},
+			Source:            mgmtv1alpha1.TransformerSource_TRANSFORMER_SOURCE_GENERATE_BUSINESS_NAME,
+			Config: &mgmtv1alpha1.TransformerConfig{
+				Config: &mgmtv1alpha1.TransformerConfig_GenerateBusinessNameConfig{
+					GenerateBusinessNameConfig: &mgmtv1alpha1.GenerateBusinessName{},
+				},
+			},
+		},
 	}
 
 	// base transformers + ee transformers

diff --git a/backend/sql/postgresql/models/transformers.go b/backend/sql/postgresql/models/transformers.go
@@ -52,6 +52,7 @@ type TransformerConfig struct {
 	TransformCharacterScramble *TransformCharacterScramble      `json:"transformCharacterScramble,omitempty"`
 	GenerateJavascript         *GenerateJavascript              `json:"generateJavascript,omitempty"`
 	GenerateCountry            *GenerateCountryConfig           `json:"generateCountryConfig,omitempty"`
+	GenerateBusinessName       *GenerateBusinessNameConfig      `json:"generateBusinessNameConfig,omitempty"`
 }
 
 type GenerateEmailConfig struct {
@@ -204,6 +205,8 @@ type GenerateCountryConfig struct {
 	GenerateFullName *bool `json:"generateFullName,omitempty"`
 }
 
+type GenerateBusinessNameConfig struct{}
+
 func (t *JobMappingTransformerModel) FromTransformerDto(tr *mgmtv1alpha1.JobMappingTransformer) error {
 	if tr == nil {
 		tr = &mgmtv1alpha1.JobMappingTransformer{}
@@ -374,6 +377,8 @@ func (t *TransformerConfig) FromTransformerConfigDto(tr *mgmtv1alpha1.Transforme
 		t.GenerateCountry = &GenerateCountryConfig{
 			GenerateFullName: tr.GetGenerateCountryConfig().GenerateFullName,
 		}
+	case *mgmtv1alpha1.TransformerConfig_GenerateBusinessNameConfig:
+		t.GenerateBusinessName = &GenerateBusinessNameConfig{}
 	default:
 		t = &TransformerConfig{}
 	}
@@ -714,6 +719,12 @@ func (t *TransformerConfig) ToTransformerConfigDto() *mgmtv1alpha1.TransformerCo
 				},
 			},
 		}
+	case t.GenerateBusinessName != nil:
+		return &mgmtv1alpha1.TransformerConfig{
+			Config: &mgmtv1alpha1.TransformerConfig_GenerateBusinessNameConfig{
+				GenerateBusinessNameConfig: &mgmtv1alpha1.GenerateBusinessName{},
+			},
+		}
 	default:
 		return &mgmtv1alpha1.TransformerConfig{}
 	}

diff --git a/docs/docs/transformers/gen-javascript-transformer.md b/docs/docs/transformers/gen-javascript-transformer.md
@@ -469,6 +469,37 @@ const newValue = neosync.generateBool({
 <br/>
 
 
+<!--
+source: generate_business_name.go
+-->
+
+### generateBusinessName
+
+Generates a random business name between 2 and 35 characters long.
+
+**Parameters**
+
+**Config**
+
+| Field    | Type | Default | Required | Description |
+| -------- | ---- | ------- | -------- | ----------- |
+| maxLength | int64 | 100 | false | Specifies the maximum length for the generated data. This field ensures that the output does not exceed a certain number of characters.
+| seed | int64 |  | false | An optional seed value used to generate deterministic outputs.
+<br/>
+
+**Example**
+
+```javascript
+
+const newValue = neosync.generateBusinessName({ 
+	maxLength: 100, 
+	seed: 1, 
+});
+
+```
+<br/>
+
+
 <!--
 source: generate_card_number.go
 -->

diff --git a/docs/openapi/mgmt/v1alpha1/anonymization.openapi.yaml b/docs/openapi/mgmt/v1alpha1/anonymization.openapi.yaml
@@ -260,6 +260,10 @@ components:
       type: object
       title: GenerateBool
       additionalProperties: false
+    mgmt.v1alpha1.GenerateBusinessName:
+      type: object
+      title: GenerateBusinessName
+      additionalProperties: false
     mgmt.v1alpha1.GenerateCardNumber:
       type: object
       allOf:
@@ -1206,6 +1210,8 @@ components:
         - anyOf:
             - required:
                 - generateBoolConfig
+            - required:
+                - generateBusinessNameConfig
             - required:
                 - generateCardNumberConfig
             - required:
@@ -1296,6 +1302,8 @@ components:
                 anyOf:
                   - required:
                       - generateBoolConfig
+                  - required:
+                      - generateBusinessNameConfig
                   - required:
                       - generateCardNumberConfig
                   - required:
@@ -1385,6 +1393,8 @@ components:
       anyOf:
         - required:
             - generateBoolConfig
+        - required:
+            - generateBusinessNameConfig
         - required:
             - generateCardNumberConfig
         - required:
@@ -1475,6 +1485,8 @@ components:
             anyOf:
               - required:
                   - generateBoolConfig
+              - required:
+                  - generateBusinessNameConfig
               - required:
                   - generateCardNumberConfig
               - required:
@@ -1739,6 +1751,10 @@ components:
             - title: transform_pii_text_config
               description: NeosyncCloud/Enterprise only transformer for anonymizing PII Text
             - $ref: '#/components/schemas/mgmt.v1alpha1.TransformPiiText'
+        generateBusinessNameConfig:
+          allOf:
+            - title: generate_business_name_config
+            - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateBusinessName'
       title: TransformerConfig
       additionalProperties: false
     mgmt.v1alpha1.TransformerMapping:

diff --git a/docs/openapi/mgmt/v1alpha1/job.openapi.yaml b/docs/openapi/mgmt/v1alpha1/job.openapi.yaml
@@ -1132,6 +1132,7 @@ components:
         - TRANSFORMER_SOURCE_GENERATE_JAVASCRIPT
         - TRANSFORMER_SOURCE_GENERATE_COUNTRY
         - TRANSFORMER_SOURCE_TRANSFORM_PII_TEXT
+        - TRANSFORMER_SOURCE_GENERATE_BUSINESS_NAME
     google.protobuf.Timestamp:
       type: string
       format: date-time
@@ -1802,6 +1803,10 @@ components:
       type: object
       title: GenerateBool
       additionalProperties: false
+    mgmt.v1alpha1.GenerateBusinessName:
+      type: object
+      title: GenerateBusinessName
+      additionalProperties: false
     mgmt.v1alpha1.GenerateCardNumber:
       type: object
       allOf:
@@ -4370,6 +4375,8 @@ components:
         - anyOf:
             - required:
                 - generateBoolConfig
+            - required:
+                - generateBusinessNameConfig
             - required:
                 - generateCardNumberConfig
             - required:
@@ -4460,6 +4467,8 @@ components:
                 anyOf:
                   - required:
                       - generateBoolConfig
+                  - required:
+                      - generateBusinessNameConfig
                   - required:
                       - generateCardNumberConfig
                   - required:
@@ -4549,6 +4558,8 @@ components:
       anyOf:
         - required:
             - generateBoolConfig
+        - required:
+            - generateBusinessNameConfig
         - required:
             - generateCardNumberConfig
         - required:
@@ -4639,6 +4650,8 @@ components:
             anyOf:
               - required:
                   - generateBoolConfig
+              - required:
+                  - generateBusinessNameConfig
               - required:
                   - generateCardNumberConfig
               - required:
@@ -4903,6 +4916,10 @@ components:
             - title: transform_pii_text_config
               description: NeosyncCloud/Enterprise only transformer for anonymizing PII Text
             - $ref: '#/components/schemas/mgmt.v1alpha1.TransformPiiText'
+        generateBusinessNameConfig:
+          allOf:
+            - title: generate_business_name_config
+            - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateBusinessName'
       title: TransformerConfig
       additionalProperties: false
     mgmt.v1alpha1.UpdateJobDestinationConnectionRequest:

diff --git a/docs/openapi/mgmt/v1alpha1/transformer.openapi.yaml b/docs/openapi/mgmt/v1alpha1/transformer.openapi.yaml
@@ -487,6 +487,7 @@ components:
         - TRANSFORMER_SOURCE_GENERATE_JAVASCRIPT
         - TRANSFORMER_SOURCE_GENERATE_COUNTRY
         - TRANSFORMER_SOURCE_TRANSFORM_PII_TEXT
+        - TRANSFORMER_SOURCE_GENERATE_BUSINESS_NAME
     google.protobuf.Timestamp:
       type: string
       format: date-time
@@ -634,6 +635,10 @@ components:
       type: object
       title: GenerateBool
       additionalProperties: false
+    mgmt.v1alpha1.GenerateBusinessName:
+      type: object
+      title: GenerateBusinessName
+      additionalProperties: false
     mgmt.v1alpha1.GenerateCardNumber:
       type: object
       allOf:
@@ -1724,6 +1729,8 @@ components:
         - anyOf:
             - required:
                 - generateBoolConfig
+            - required:
+                - generateBusinessNameConfig
             - required:
                 - generateCardNumberConfig
             - required:
@@ -1814,6 +1821,8 @@ components:
                 anyOf:
                   - required:
                       - generateBoolConfig
+                  - required:
+                      - generateBusinessNameConfig
                   - required:
                       - generateCardNumberConfig
                   - required:
@@ -1903,6 +1912,8 @@ components:
       anyOf:
         - required:
             - generateBoolConfig
+        - required:
+            - generateBusinessNameConfig
         - required:
             - generateCardNumberConfig
         - required:
@@ -1993,6 +2004,8 @@ components:
             anyOf:
               - required:
                   - generateBoolConfig
+              - required:
+                  - generateBusinessNameConfig
               - required:
                   - generateCardNumberConfig
               - required:
@@ -2257,6 +2270,10 @@ components:
             - title: transform_pii_text_config
               description: NeosyncCloud/Enterprise only transformer for anonymizing PII Text
             - $ref: '#/components/schemas/mgmt.v1alpha1.TransformPiiText'
+        generateBusinessNameConfig:
+          allOf:
+            - title: generate_business_name_config
+            - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateBusinessName'
       title: TransformerConfig
       additionalProperties: false
     mgmt.v1alpha1.UpdateUserDefinedTransformerRequest: