feat: add event enrichment client package

.github/workflows/amplify_event_enrichment.yaml

@@ -0,0 +1,64 @@
+# Generated with aft. To update, run: `aft generate workflows`
+name: amplify_event_enrichment
+on:
+  push:
+    branches:
+      - main
+      - stable
+    paths:
+      - '.github/workflows/amplify_event_enrichment.yaml'
+      - '.github/workflows/flutter_vm.yaml'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment/**/*.dart'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment/**/*.yaml'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment/lib/**/*'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment/test/**/*'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment_dart/lib/**/*.dart'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment_dart/pubspec.yaml'
+      - 'packages/amplify_foundation/amplify_foundation_dart/lib/**/*.dart'
+      - 'packages/amplify_foundation/amplify_foundation_dart/pubspec.yaml'
+      - 'packages/amplify_lints/lib/**/*.yaml'
+      - 'packages/amplify_lints/pubspec.yaml'
+      - 'packages/aws_common/lib/**/*.dart'
+      - 'packages/aws_common/pubspec.yaml'
+  pull_request:
+    paths:
+      - '.github/workflows/amplify_event_enrichment.yaml'
+      - '.github/workflows/flutter_vm.yaml'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment/**/*.dart'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment/**/*.yaml'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment/lib/**/*'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment/test/**/*'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment_dart/lib/**/*.dart'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment_dart/pubspec.yaml'
+      - 'packages/amplify_foundation/amplify_foundation_dart/lib/**/*.dart'
+      - 'packages/amplify_foundation/amplify_foundation_dart/pubspec.yaml'
+      - 'packages/amplify_lints/lib/**/*.yaml'
+      - 'packages/amplify_lints/pubspec.yaml'
+      - 'packages/aws_common/lib/**/*.dart'
+      - 'packages/aws_common/pubspec.yaml'
+  schedule:
+    - cron: "0 13 * * 1" # Every Monday at 06:00 PST
+  workflow_dispatch:
+defaults:
+  run:
+    shell: bash
+
+# These permissions are needed to interact with GitHub's OIDC Token endpoint.
+permissions:
+  id-token: write
+  contents: read
+
+# Cancels in-progress job when there is another push to same ref.
+# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-only-cancel-in-progress-jobs-or-runs-for-the-current-workflow
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    uses: ./.github/workflows/flutter_vm.yaml
+    secrets: inherit
+    with:
+      package-name: amplify_event_enrichment
+      working-directory: packages/amplify_event_enrichment/amplify_event_enrichment
+      has-goldens: false

.github/workflows/amplify_event_enrichment_dart.yaml

@@ -0,0 +1,59 @@
+# Generated with aft. To update, run: `aft generate workflows`
+name: amplify_event_enrichment_dart
+on:
+  push:
+    branches:
+      - main
+      - stable
+    paths:
+      - '.github/workflows/amplify_event_enrichment_dart.yaml'
+      - '.github/workflows/dart_vm.yaml'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment_dart/**/*.dart'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment_dart/**/*.yaml'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment_dart/lib/**/*'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment_dart/test/**/*'
+      - 'packages/amplify_foundation/amplify_foundation_dart/lib/**/*.dart'
+      - 'packages/amplify_foundation/amplify_foundation_dart/pubspec.yaml'
+      - 'packages/amplify_lints/lib/**/*.yaml'
+      - 'packages/amplify_lints/pubspec.yaml'
+      - 'packages/aws_common/lib/**/*.dart'
+      - 'packages/aws_common/pubspec.yaml'
+  pull_request:
+    paths:
+      - '.github/workflows/amplify_event_enrichment_dart.yaml'
+      - '.github/workflows/dart_vm.yaml'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment_dart/**/*.dart'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment_dart/**/*.yaml'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment_dart/lib/**/*'
+      - 'packages/amplify_event_enrichment/amplify_event_enrichment_dart/test/**/*'
+      - 'packages/amplify_foundation/amplify_foundation_dart/lib/**/*.dart'
+      - 'packages/amplify_foundation/amplify_foundation_dart/pubspec.yaml'
+      - 'packages/amplify_lints/lib/**/*.yaml'
+      - 'packages/amplify_lints/pubspec.yaml'
+      - 'packages/aws_common/lib/**/*.dart'
+      - 'packages/aws_common/pubspec.yaml'
+  schedule:
+    - cron: "0 13 * * 1" # Every Monday at 06:00 PST
+  workflow_dispatch:
+defaults:
+  run:
+    shell: bash
+
+# These permissions are needed to interact with GitHub's OIDC Token endpoint.
+permissions:
+  id-token: write
+  contents: read
+
+# Cancels in-progress job when there is another push to same ref.
+# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-only-cancel-in-progress-jobs-or-runs-for-the-current-workflow
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    uses: ./.github/workflows/dart_vm.yaml
+    secrets: inherit
+    with:
+      package-name: amplify_event_enrichment_dart
+      working-directory: packages/amplify_event_enrichment/amplify_event_enrichment_dart

actions/bin/log_cw_metric.dart

@@ -95,6 +95,7 @@ Future<void> logMetric() async {
     'amplify_native_legacy_wrapper',
     'kinesis',
     'connect_client',
+    'event_enrichment',
     'pub_server',
   ];
 

packages/amplify_event_enrichment/amplify_event_enrichment/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+ - Initial release ([#7029](https://github.com/aws-amplify/amplify-flutter/pull/7029))

packages/amplify_event_enrichment/amplify_event_enrichment/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

packages/amplify_event_enrichment/amplify_event_enrichment/README.md

@@ -0,0 +1,45 @@
+# amplify_event_enrichment
+
+A Flutter implementation for on-device event enrichment with automatic session lifecycle tracking, device metadata collection, and a persistent client ID.
+
+## Category / Platform Support
+
+| Category         | Android | iOS | Web | Windows | MacOS | Linux |
+| ---------------- | :-----: | :-: | :-: | :-----: | :---: | :---: |
+| Event Enrichment |   ✅    | ✅  | ✅  |   ✅    |  ✅   |  ✅   |
+
+## Getting Started
+
+Create a client and record events. The client tracks session lifecycle
+automatically, collects basic device metadata, and stamps a persistent client
+ID on every event. `record` returns a `Result`, so failures surface through the
+`Ok`/`Error` contract rather than as thrown exceptions.
+
+```dart
+import 'dart:convert';
+
+import 'package:amplify_event_enrichment/amplify_event_enrichment.dart';
+
+final client = await EventEnrichmentClientFlutter.create(
+  appId: 'my-app-id',
+  sdkMetadata: SdkMetadata(name: 'amplify-flutter', version: '2.0.0'),
+);
+
+final result = await client.record(
+  'button_clicked',
+  attributes: {'screen': 'home'},
+);
+switch (result) {
+  case Ok(:final value):
+    print(jsonEncode(value.toJson()));
+  case Error(:final error):
+    print('Failed to record event: $error');
+}
+```
+
+For richer device information (manufacturer, model), supply a custom
+`DeviceMetadataProvider` to `EventEnrichmentClientFlutter.create`. A custom
+`ClientIdProvider` can be supplied the same way to source the client ID from
+your own store.
+
+### Visit our [Web Site](https://docs.amplify.aws/) to learn more about AWS Amplify.

packages/amplify_event_enrichment/amplify_event_enrichment/analysis_options.yaml

@@ -0,0 +1 @@
+include: package:amplify_lints/library.yaml

packages/amplify_event_enrichment/amplify_event_enrichment/lib/amplify_event_enrichment.dart

@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/// Amplify Event Enrichment client for Flutter.
+library;
+
+// Re-export everything from the Dart package.
+export 'package:amplify_event_enrichment_dart/amplify_event_enrichment.dart';
+
+// Export Flutter-specific implementations.
+export 'src/event_enrichment_client_flutter.dart';
+export 'src/flutter_lifecycle_observer.dart';
+export 'src/shared_preferences_client_id_provider.dart';