imean-replay-sdk

iMean Replay SDK

iMean Replay SDK is a powerful toolkit designed to assist developers in integrating replay functionality into their applications. This SDK is tailored for high performance and ease of use, supporting modern JavaScript frameworks and environments.

Table of Contents

• Features
• Installation
• Usage
• Supported Browsers
• Scripts
• Release Process

Features

• Modular Design: Includes both UMD and ES modules.
• Cross-Platform: Works in various environments with support for modern web frameworks.
• Performance Optimizations: Leverages popular libraries like immer and framer-motion for optimal performance.
• TypeScript Support: Fully typed and ready to use in TypeScript projects.
• Playwright Testing: Integrated end-to-end testing using Playwright.

Installation

You can install the iMean Replay SDK via npm:

npm install imean-replay-sdk

Or via yarn:

yarn add imean-replay-sdk

Or via pnpm:

pnpm add imean-replay-sdk

Usage

To start using the iMean Replay SDK in your project, import the module as follows:

import ReplaySDK from 'imean-replay-sdk';

ReplaySDK.init({
  mode: 'Default',
  workflow: {
    id: 'Create Event',
    steps: [
      {
        title: 'Click Create',
        id: 'AhPPa81go4KMr5CotK2eJ',
        type: 'Action',
        selector: '.mr0WL ',
        actionType: 'click',
        value: 'Create'
      },
      {
        title: 'Click Event',
        id: 'VS6c_J4nOALtUnk3mWVGW',
        type: 'Action',
        selector: '.z80M1.QJXRJc.FwR7Pc >.uyYuVb.oJeWuf >.jO7h3c ',
        actionType: 'click',
        value: 'Event'
      },
      {
        title: 'Type Title Conetnt',
        id: 'jOoGrFIxBo5UMA7i3VsrC',
        type: 'Action',
        selector: '#c96 ',
        actionType: 'type',
        value: 'test'
      },
      {
        title: 'Click Save',
        id: 'TzOr7UO2_oHTsU9youDhH',
        type: 'Action',
        selector:
          '.VfPpkd-LgbsSe.VfPpkd-LgbsSe-OWXEXe-k8QpJ.VfPpkd-LgbsSe-OWXEXe-dgl2Hf.nCP5yc.AjY5Oe.DuMIQc.LQeN7.pEVtpe >.VfPpkd-vQzf8d ',
        actionType: 'type',
        value: 'Save'
      }
    ]
  }
});

ReplaySDK.runAutomation({ index: 0 });

Supported Browsers

The iMean Replay SDK supports the following browser versions:

• Chrome: Version 55 and above

Scripts

This project includes various scripts to help with development and building:

• Build: Compiles the project into distributable formats.

  pnpm build
  

• Development: Runs a development server with live reloading.

  pnpm dev
  

• Linting: Lints the codebase and fixes issues automatically.

  pnpm lint
  

• Testing: Runs the Playwright tests.

  pnpm test
  

• Format: Formats the codebase using Prettier.

  pnpm format
  

Release Process

Releases for the iMean Replay SDK are handled using semantic versioning, driven by commit messages. The process is as follows:

1. Commit Changes: When you're ready to commit your changes, use the following command:

   pnpm commit
   

   This command will guide you through crafting a well-structured commit message that adheres to the conventional commit standard. This is crucial for enabling automated semantic versioning.

2. Automated Release: Once your changes are merged into the main branch, our CI/CD pipeline will automatically analyze the commit messages and determine whether a new release is necessary. Depending on the nature of the changes (e.g., features, fixes, breaking changes)

For more details, please refer to our Guide.