Skip to content

TerminalAPI: PredefinedContentHelper for managing Display Events #1527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

gcatanese
Copy link
Contributor

Provide PredefinedContentHelper to extract and parse ReferenceID.

Enums are also defined to map the supported Display notification types.

const ReferenceID = "TransactionID=oLkO001517998574000&TimeStamp=2018-02-07T10%3a16%3a14.000Z&event=PIN_ENTERED";

const helper = new PredefinedContentHelper(ReferenceID);
const event = helper.getEvent() // returns DisplayNotificationEvent.PIN_ENTERED

Fix #1465

@gcatanese gcatanese requested a review from a team as a code owner July 11, 2025 07:54
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @gcatanese, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new helper utility and associated enumerations to streamline the parsing and management of ReferenceID strings found in Terminal API display notifications. The primary goal is to provide a robust and type-safe way to interpret these notification events, making it easier to integrate and react to terminal-initiated actions.

Highlights

  • New Utility Class: I've introduced a new utility class, PredefinedContentHelper, designed to parse and manage ReferenceID strings. This helper simplifies the extraction of key information such as event types, TransactionID, TimeStamp, and other arbitrary key-value pairs from these strings.
  • Event Type Enumeration: To provide type safety and improve readability, I've defined the DisplayNotificationEvent enum. This enum maps all supported display notification event types, as referenced in the Adyen documentation, ensuring consistent handling of these events.
  • Comprehensive Test Coverage: I've added a dedicated test file (terminalAPIPredefinedContentHelper.spec.ts) with comprehensive unit tests for the new PredefinedContentHelper. These tests validate the parsing and extraction logic across various scenarios, including valid and invalid inputs, and edge cases like empty ReferenceIDs.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a PredefinedContentHelper class to parse ReferenceID strings from terminal display notifications. The implementation is clean and uses URLSearchParams effectively, and the tests provide good coverage. Suggestions have been made to improve maintainability and conciseness.

Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Provide DisplayEvent enum (and ReferenceID enum)
1 participant