Pear Apps Feedback Library

A lightweight JavaScript library for collecting and submitting user feedback from various applications to different destinations like Slack and Google Forms. This library provides a consistent interface for sending bug reports, feature requests, and security issues across mobile, desktop, and browser extension applications.

Table of Contents

• Features
• Security Notice
• Installation
• Usage Examples
• API Reference
• Dependencies
• Testing
• Related Projects

Features

• Send feedback directly to Slack channels
• Submit feedback to Google Forms
• Customizable fields and formatting
• Support for different application types (Mobile, Desktop, Browser Extension)
• Support for different feedback types (Bug Reports, Feature Requests, Security Issues)
• Highly configurable for different use cases
• No external dependencies

Security Notice

1. To ensure the security and integrity of your projects, please note that official PearPass packages are distributed exclusively through our GitHub organization.
2. Any packages with similar names found on the npm registry or other third-party package managers are not affiliated with PearPass and should be strictly avoided. We recommend installing directly from this repository to ensure you are using the verified, open-source version.

Installation

Install the package via npm:

npm install git+https://github.com/tetherto/pear-apps-lib-feedback.git

Usage Examples

Sending Feedback to Slack

import { sendSlackFeedback } from '@tetherto/pear-apps-lib-feedback';

// Send a bug report to Slack
sendSlackFeedback({
  webhookUrPath: '/T00000000/B00000000/xxxxxxxxxxxxxxxxxxxxxxxx',
  topic: 'BUG_REPORT',
  app: 'MOBILE',
  operatingSystem: 'iOS 15.4',
  deviceModel: 'iPhone 13',
  message: 'The app crashes when I tap on the settings button',
  appVersion: '1.2.3'
});

Sending Feedback to Google Forms

import { sendGoogleFormFeedback } from '@tetherto/pear-apps-lib-feedback';

// Send a feature request to Google Forms
sendGoogleFormFeedback({
  formKey: '1FAIpQLSd8X-xxxxxxxxxxxxxxxxxxxxxxxxxxx',
  mapping: {
    timestamp: 'entry.1111111111',
    topic: 'entry.2222222222',
    app: 'entry.3333333333',
    operatingSystem: 'entry.4444444444',
    deviceModel: 'entry.5555555555',
    message: 'entry.6666666666',
    appVersion: 'entry.7777777777'
  },
  topic: 'FEATURE_REQUEST',
  app: 'DESKTOP',
  operatingSystem: 'Windows 11',
  deviceModel: 'HP Pavilion',
  message: 'I would love to have dark mode in the next update',
  appVersion: '2.1.0',
  additionalFields: [
    { key: 'entry.8888888888', value: 'Additional info' }
  ]
});

API Reference

sendSlackFeedback(config)

Sends feedback to a Slack channel using a webhook.

Parameters:

• config (Object):
  • webhookUrPath (string): The path part of the Slack webhook URL
  • topic (string, optional): Type of feedback ('BUG_REPORT', 'FEATURE_REQUEST', 'SECURITY_ISSUE')
  • app (string, optional): Type of app ('MOBILE', 'DESKTOP', 'BROWSER_EXTENSION')
  • operatingSystem (string, optional): OS information
  • deviceModel (string, optional): Device model information
  • message (string): The feedback message content
  • appVersion (string, optional): Version of the app
  • customFields (Array, optional): Additional fields to include in the message
  • additionalAttachment (Object, optional): Additional attachment properties

sendGoogleFormFeedback(config)

Sends feedback to a Google Form.

Parameters:

• config (Object):
  • formKey (string): The key of the Google Form
  • mapping (Object, optional): Maps feedback fields to Google Form entry IDs
  • topic (string, optional): Type of feedback ('BUG_REPORT', 'FEATURE_REQUEST', 'SECURITY_ISSUE')
  • app (string, optional): Type of app ('MOBILE', 'DESKTOP', 'BROWSER_EXTENSION')
  • operatingSystem (string, optional): OS information
  • deviceModel (string, optional): Device model information
  • message (string): The feedback message content
  • appVersion (string, optional): Version of the app
  • additionalFields (Array, optional): Additional fields to include in the form submission

Dependencies

This library has no external runtime dependencies.

Testing

The library includes unit tests for all functionality. To run the tests:

npm test

Related Projects

• @tetherto/pearpass-app-desktop - A desktop app for PearPass, a password manager
• @tetherto/pearpass-app-mobile - A mobile app for PearPass, a password manager
• @tetherto/pearpass-app-browser-extension - A nrowser extension app for PearPass, a password manager
• @tetherto/tether-dev-docs - Documentations and guides for developers

License

This project is licensed under the Apache License, Version 2.0. See the LICENSE file for details.