feat: add optional custom label directive (#104)

* feat: add optional custom label directive Useful for labelling "Hero Block (depcreated)" or altering user-friendly labels without breaking the schema. * refactor: simplify label directive * chore: add tests and update changeset * chore: update custom label in tests to be different to the normal fallback
labd · Aug 12, 2024 · 6131e70 · 6131e70
1 parent dd92fc4
commit 6131e70
Show file tree

Hide file tree

Showing 9 changed files with 93 additions and 1 deletion.
diff --git a/.changeset/lazy-clocks-sparkle.md b/.changeset/lazy-clocks-sparkle.md
@@ -0,0 +1,6 @@
+---
+"amplience-graphql-codegen-terraform": minor
+"amplience-graphql-codegen-common": minor
+---
+
+Add optional directive for custom label override
diff --git a/packages/common/src/directives.ts b/packages/common/src/directives.ts
@@ -41,5 +41,6 @@ export const schemaPrepend = gql`
     visualizations: Boolean
     icon: String
     autoSync: Boolean
+    label: String
   ) on OBJECT
 `;
diff --git a/packages/plugin-terraform/examples/output/example.tf b/packages/plugin-terraform/examples/output/example.tf
@@ -166,3 +166,21 @@ resource "amplience_content_type_assignment" "test_visualizations" {
   repository_id   = data.amplience_content_repository.website1.id
 }
 
+
+resource "amplience_content_type_schema" "test_custom_label" {
+  body             = file("${path.module}/schemas/test-custom-label.json")
+  schema_id        = "https://schema-examples.com/test-custom-label"
+  validation_level = "CONTENT_TYPE"
+  auto_sync        = true
+}
+
+resource "amplience_content_type" "test_custom_label" {
+  content_type_uri = amplience_content_type_schema.test_custom_label.schema_id
+  label            = "Test Altered Custom Label"
+  status           = "ACTIVE"
+}
+
+resource "amplience_content_type_assignment" "test_custom_label" {
+  content_type_id = amplience_content_type.test_custom_label.id
+  repository_id   = data.amplience_content_repository.website1.id
+}
diff --git a/packages/plugin-terraform/src/lib/visitor.ts b/packages/plugin-terraform/src/lib/visitor.ts
@@ -75,11 +75,15 @@ export const createObjectTypeVisitor =
       ? maybeDirectiveValue<StringValueNode>(directive, "icon")?.value
       : undefined;
 
+    const label = directive
+      ? maybeDirectiveValue<StringValueNode>(directive, "label")?.value
+      : undefined;
+
     const dynamicVisualization = visualization?.find(hasProperty("for_each"));
 
     const contentType = tfg.resource("amplience_content_type", name, {
       content_type_uri: schema.attr("schema_id"),
-      label: capitalCase(node.name.value),
+      label: label ?? capitalCase(node.name.value),
       icon: iconUrl ? { size: 256, url: iconUrl } : undefined,
       status: "ACTIVE",
       'dynamic"visualization"':

diff --git a/packages/plugin-terraform/test/testdata/base.graphql b/packages/plugin-terraform/test/testdata/base.graphql
@@ -31,6 +31,10 @@ type TestNoAutoSync @amplienceContentType {
   name: String
 }
 
+type TestCustomLabel @amplienceContentType(label: "Test Altered Custom Label") {
+  name: String
+}
+
 type NotATest {
   name: String!
 }
diff --git a/packages/plugin-terraform/test/testdata/base_repo_for_each.graphql b/packages/plugin-terraform/test/testdata/base_repo_for_each.graphql
@@ -26,6 +26,10 @@ type TestNoAutoSync @amplienceContentType {
   name: String
 }
 
+type TestCustomLabel @amplienceContentType(label: "Test Altered Custom Label") {
+  name: String
+}
+
 type NotATest {
   name: String!
 }
diff --git a/packages/plugin-terraform/test/testdata/expected/base.tf b/packages/plugin-terraform/test/testdata/expected/base.tf
@@ -205,3 +205,21 @@ resource "amplience_content_type_assignment" "test_no_auto_sync"{
 content_type_id = amplience_content_type.test_no_auto_sync.id
 repository_id = data.amplience_content_repository.website1.id
 }
+
+resource "amplience_content_type_schema" "test_custom_label"{
+body = file("${path.module}/schemas/test-custom-label.json")
+schema_id = "https://schema-examples.com/test-custom-label"
+validation_level = "CONTENT_TYPE"
+auto_sync = true
+}
+
+resource "amplience_content_type" "test_custom_label"{
+content_type_uri = amplience_content_type_schema.test_custom_label.schema_id
+label = "Test Altered Custom Label"
+status = "ACTIVE"
+}
+
+resource "amplience_content_type_assignment" "test_custom_label"{
+content_type_id = amplience_content_type.test_custom_label.id
+repository_id = data.amplience_content_repository.website1.id
+}
diff --git a/packages/plugin-terraform/test/testdata/expected/base_repo_for_each.tf b/packages/plugin-terraform/test/testdata/expected/base_repo_for_each.tf
@@ -178,3 +178,22 @@ for_each = var.variables["CONTENT_REPO_MAP"]
 content_type_id = amplience_content_type.test_no_auto_sync.id
 repository_id = each.value
 }
+
+resource "amplience_content_type_schema" "test_custom_label"{
+body = file("${path.module}/schemas/test-custom-label.json")
+schema_id = "https://schema-examples.com/test-custom-label"
+validation_level = "CONTENT_TYPE"
+auto_sync = true
+}
+
+resource "amplience_content_type" "test_custom_label"{
+content_type_uri = amplience_content_type_schema.test_custom_label.schema_id
+label = "Test Altered Custom Label"
+status = "ACTIVE"
+}
+
+resource "amplience_content_type_assignment" "test_custom_label"{
+for_each = var.variables["CONTENT_REPO_MAP"]
+content_type_id = amplience_content_type.test_custom_label.id
+repository_id = each.value
+}
diff --git a/packages/plugin-terraform/test/testdata/expected/base_without_provider.tf b/packages/plugin-terraform/test/testdata/expected/base_without_provider.tf
@@ -197,3 +197,21 @@ resource "amplience_content_type_assignment" "test_no_auto_sync"{
 content_type_id = amplience_content_type.test_no_auto_sync.id
 repository_id = data.amplience_content_repository.website1.id
 }
+
+resource "amplience_content_type_schema" "test_custom_label"{
+body = file("${path.module}/schemas/test-custom-label.json")
+schema_id = "https://schema-examples.com/test-custom-label"
+validation_level = "CONTENT_TYPE"
+auto_sync = true
+}
+
+resource "amplience_content_type" "test_custom_label"{
+content_type_uri = amplience_content_type_schema.test_custom_label.schema_id
+label = "Test Altered Custom Label"
+status = "ACTIVE"
+}
+
+resource "amplience_content_type_assignment" "test_custom_label"{
+content_type_id = amplience_content_type.test_custom_label.id
+repository_id = data.amplience_content_repository.website1.id
+}