R&A Data API Fetching Client 🚀

Sample GraphQL data fetching client for retrieving and processing structured profile information from the R&A Data API.

⚠ Important: This is NOT an official Oracle API client. It is a sample client built for demo purposes. Use it at your own risk.

📌 Table of Contents

• R&A Data API Fetching Client 🚀
  • Features ✨
  • Architecture 🏗️
  • Installation 🛠
  • Configuration ⚙️
  • Run ▶️
  • License 📜
  • Disclaimer ⚠️

Features ✨

• 🚀 Loads connection parameters from environment variables
• 🔄 Automatically refreshes OAuth tokens before expiration
• 📡 Supports GraphQL queries with request/response or request/stream modes
• 📥 Enables streaming mode if @stream directive is present
• 🗑 Filters out null values from responses (optional)
• 📂 Saves fetched data in structured JSON files
• 📑 Logs execution details at different levels (info, debug, silly)
• 🔧 Supports dynamic query files and filter variables from an external file
• 🔌 Custom plugins (./src/plugins) for stream processing - fileWriter.ts provided as sample

Architecture 🏗️

Below a conceptual architecture diagram illustrating the workflow of this client:

Installation 🛠

• Install Node.js:

  It is recommended to use Node Version Manager (nvm) for managing Node versions:

  NODE_VERSION=v20.11.0
  nvm install $NODE_VERSION
  nvm alias default $NODE_VERSION
  nvm use default

• Install project dependencies:

  npm install

Configuration ⚙️

Before running the application, set the required environment variables. If testing locally, these can be stored in an .env file:

  touch .env

Here are the essential environment variables and their purpose:

• 🌍 APIGW_URL: The API Gateway URL for accessing Oracle Hospitality APIs. Example:

  APIGW_URL=https://your-api-gateway-url

• 🔑 APP_KEY, CLIENT_ID, CLIENT_SECRET: Credentials required for authentication. Example:

  APP_KEY=your-app-key
  CLIENT_ID=your-client-id
  CLIENT_SECRET=your-client-secret

• 🏢 ENTERPRISE_ID: The enterprise identifier related to the customer environment. Example:

  ENTERPRISE_ID=your-enterprise-id

• 🗑 EXCLUDE_NULL: Set to true to remove null values from responses. Example:

  EXCLUDE_NULL=true

• 📝 PLUGIN_NAME: Specifies which plugin should be used for processing data streams. Example:

  PLUGIN_NAME=fileWriter

• 🔍 QUERY_NAME & FILTER_NAME: Define which query and filter files (from ./queries and ./filters) should be used. Example:

  QUERY_NAME=profileIndividuals
  FILTER_NAME=profileIndividuals

• 🔄 FILTER_VARS: Defines dynamic variables for filters. Any placeholder like {{var}} in the filter file will be replaced with the specified values. Example:

  FILTER_VARS=hotelId:HOTEL123,limit:100

• 📝 LOGLEVEL: Defines the log verbosity level (silly, trace, debug, info, warn, error, fatal). Example:

  LOGLEVEL=info

ℹ️ To use an environment file other than .env, set the ENVPATH variable, e.g., export ENVPATH=./dev.env.

Run ▶️

Once all required environment variables are set, the project can be executed with:

npm start

To run in development mode:

npm run dev

License 📜

This project is available under the Universal Permissive License v 1.0.

See LICENSE for details.

Disclaimer ⚠️

This is NOT an official Oracle product. It is provided for demonstration purposes only, without any guarantees of reliability, accuracy, or completeness. Use it at your own risk.