chore: Update label syntax for analytics metadata (#2519)

Co-authored-by: Francesco Longo <[email protected]>
cloudscape-design · Jul 26, 2024 · 89f643f · 89f643f
1 parent cf0f2b0
commit 89f643f
Show file tree

Hide file tree

Showing 19 changed files with 31 additions and 23 deletions.
diff --git a/src/button-dropdown/analytics-metadata/interfaces.ts b/src/button-dropdown/analytics-metadata/interfaces.ts
@@ -1,6 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata';
+
 export interface GeneratedAnalyticsMetadataButtonDropdownClick {
   action: 'click';
   detail: {
@@ -13,7 +15,7 @@ export interface GeneratedAnalyticsMetadataButtonDropdownClick {
 export interface GeneratedAnalyticsMetadataButtonDropdownExpand {
   action: 'expand';
   detail: {
-    label: string;
+    label: string | LabelIdentifier;
     expanded: string;
     position?: string;
     id?: string;

diff --git a/src/button-dropdown/category-elements/expandable-category-element.tsx b/src/button-dropdown/category-elements/expandable-category-element.tsx
@@ -78,7 +78,7 @@ const ExpandableCategoryElement = ({
               action: 'expand',
               detail: {
                 position: position || '0',
-                label: '',
+                label: { root: 'self' },
                 id: item.id || '',
                 expanded: `${!expanded}`,
               },

diff --git a/src/button-dropdown/category-elements/mobile-expandable-category-element.tsx b/src/button-dropdown/category-elements/mobile-expandable-category-element.tsx
@@ -76,7 +76,7 @@ const MobileExpandableCategoryElement = ({
               action: 'expand',
               detail: {
                 position: position || '0',
-                label: '',
+                label: { root: 'self' },
                 id: item.id || '',
                 expanded: `${!expanded}`,
               },

diff --git a/src/button/analytics-metadata/interfaces.ts b/src/button/analytics-metadata/interfaces.ts
@@ -1,16 +1,18 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata';
+
 interface GeneratedAnalyticsMetadataButtonClick {
   action: 'click';
   detail: {
-    label: string;
+    label: string | LabelIdentifier;
   };
 }
 
 interface GeneratedAnalyticsMetadataButtonComponent {
   name: 'awsui.Button';
-  label: string;
+  label: string | LabelIdentifier;
   properties: {
     variant: string;
     disabled: string;

diff --git a/src/button/internal.tsx b/src/button/internal.tsx
@@ -167,12 +167,12 @@ export const InternalButton = React.forwardRef(
       ? {}
       : {
           action: 'click',
-          detail: { label: '' },
+          detail: { label: { root: 'self' } },
         };
     if (__injectAnalyticsComponentMetadata) {
       analyticsMetadata.component = {
         name: 'awsui.Button',
-        label: '',
+        label: { root: 'self' },
         properties: { variant, disabled: `${disabled}` },
       };
     }

diff --git a/src/checkbox/analytics-metadata/interfaces.ts b/src/checkbox/analytics-metadata/interfaces.ts
@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata/interfaces';
+import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata';
 
 export interface GeneratedAnalyticsMetadataCheckboxSelect {
   action: 'select';

diff --git a/src/checkbox/internal.tsx b/src/checkbox/internal.tsx
@@ -70,7 +70,7 @@ const InternalCheckbox = React.forwardRef<CheckboxProps.Ref, InternalProps>(
     const analyticsMetadata: GeneratedAnalyticsMetadataFragment = {};
     const analyticsComponentMetadata: GeneratedAnalyticsMetadataCheckboxComponent = {
       name: 'awsui.Checkbox',
-      label: '',
+      label: { root: 'self' },
     };
     if (__injectAnalyticsComponentMetadata) {
       analyticsMetadata.component = analyticsComponentMetadata;

diff --git a/src/container/analytics-metadata/interfaces.ts b/src/container/analytics-metadata/interfaces.ts
@@ -1,7 +1,9 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata';
+
 export interface GeneratedAnalyticsMetadataContainerComponent {
   name: 'awsui.Container';
-  label: string;
+  label: string | LabelIdentifier;
 }
diff --git a/src/container/index.tsx b/src/container/index.tsx
@@ -34,7 +34,7 @@ export default function Container({
 
   const analyticsComponentMetadata: GeneratedAnalyticsMetadataContainerComponent = {
     name: 'awsui.Container',
-    label: '',
+    label: { root: 'self' },
   };
 
   return (

diff --git a/src/form/analytics-metadata/interfaces.ts b/src/form/analytics-metadata/interfaces.ts
@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata/interfaces';
+import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata';
 
 interface GeneratedAnalyticsMetadataFormComponent {
   name: 'awsui.Form';

diff --git a/src/link/analytics-metadata/interfaces.ts b/src/link/analytics-metadata/interfaces.ts
@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata/interfaces';
+import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata';
 
 interface GeneratedAnalyticsMetadataLinkClick {
   action: 'click';

diff --git a/src/link/index.tsx b/src/link/index.tsx
@@ -21,12 +21,12 @@ const Link = React.forwardRef(
     const analyticsMetadata: GeneratedAnalyticsMetadataLinkFragment = {
       action: 'click',
       detail: {
-        label: '',
+        label: { root: 'self' },
         external: `${external}`,
       },
       component: {
         name: 'awsui.Link',
-        label: '',
+        label: { root: 'self' },
         properties: { variant: props.variant || 'secondary' },
       },
     };

diff --git a/src/pagination/analytics-metadata/interfaces.ts b/src/pagination/analytics-metadata/interfaces.ts
@@ -1,17 +1,19 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata';
+
 export interface GeneratedAnalyticsMetadataPaginationClick {
   action: 'click';
   detail: {
-    label: string;
+    label: string | LabelIdentifier;
     position?: string;
   };
 }
 
 export interface GeneratedAnalyticsMetadataPaginationComponent {
   name: 'awsui.Pagination';
-  label: string;
+  label: string | LabelIdentifier;
   properties: {
     openEnd: string;
     pagesCount: string;

diff --git a/src/pagination/index.tsx b/src/pagination/index.tsx
@@ -21,7 +21,7 @@ export default function Pagination(props: PaginationProps) {
       {...getAnalyticsMetadataAttribute({
         component: {
           name: 'awsui.Pagination',
-          label: '',
+          label: { root: 'self' },
           properties: {
             openEnd: `${!!props.openEnd}`,
             pagesCount: `${props.pagesCount || ''}`,

diff --git a/src/pagination/internal.tsx b/src/pagination/internal.tsx
@@ -69,7 +69,7 @@ function PageButton({
           : getAnalyticsMetadataAttribute({
               action: 'click',
               detail: {
-                label: '',
+                label: { root: 'self' },
               },
             } as GeneratedAnalyticsMetadataPaginationClick))}
       >

diff --git a/src/radio-group/analytics-metadata/interfaces.ts b/src/radio-group/analytics-metadata/interfaces.ts
@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata/interfaces';
+import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata';
 
 export interface GeneratedAnalyticsMetadataRadioGroupSelect {
   action: 'click';

diff --git a/src/radio-group/index.tsx b/src/radio-group/index.tsx
@@ -22,7 +22,7 @@ const RadioGroup = React.forwardRef((props: RadioGroupProps, ref: React.Ref<Radi
       {...getAnalyticsMetadataAttribute({
         component: {
           name: 'awsui.RadioGroup',
-          label: '',
+          label: { root: 'self' },
         } as GeneratedAnalyticsMetadataRadioGroupComponent,
       })}
     />

diff --git a/src/table/analytics-metadata/interfaces.ts b/src/table/analytics-metadata/interfaces.ts
@@ -1,7 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata/interfaces';
+import { LabelIdentifier } from '@cloudscape-design/component-toolkit/internal/analytics-metadata';
 
 export interface GeneratedAnalyticsMetadataTableSelect {
   action: 'select';

diff --git a/src/table/index.tsx b/src/table/index.tsx
@@ -46,7 +46,7 @@ const Table = React.forwardRef(
 
     const analyticsComponentMetadata: GeneratedAnalyticsMetadataTableComponent = {
       name: 'awsui.Table',
-      label: '',
+      label: { root: 'self' },
       properties: {
         selectionType: props.selectionType || 'none',
         itemsCount: `${items.length}`,