@otjs/plaintext

Description

Exports Operational Transformation on Plain Text content.

Installation

• To install using Pnpm (recommended):

  pnpm add @otjs/ace

• To install using Yarn:

  yarn add @otjs/plaintext

• To install using Npm:

  npm i @otjs/plaintext --save

Usage

import { PlainTextOperation } from "@otjs/plaintext";

const operation = new PlainTextOperation();

Note: An API documentation will be shipped along with the package. This will power intellisense in the editor of your choice.

Testing

We are using Jest to form our Unit Test Suite. Nyc (formerly known as Istanbul) is used for coverage reporting.

To run all the unit test suites in local dev environment, run the following after dependencies have been installed:

yarn test

Reporting a Bug

Head on to Discussion section to report a bug or to ask for any feature. Use this template to make it structural and helpful for the maintainer and the contributors. Feel to add your queries about using this library as well under Q & A section of it. Remember, do not create any Issues by yourself, maintainers of this repository will open one if deemed necessary.

Changelog

See CHANGELOG for more details on what has been changed in the latest release.

Contributing

See Contributing Guidelines.

License

This project is licensed under the terms of the MIT license, see LICENSE for more details.

CHANGELOG

v0.2.2

Changed

• Uniform Event Emitter interface and implementation extended across all event-driven modules. Tracker Work Log

Documentation

• Changed preferred package manager from yarn to pnpm and updated documentation accordingly. Tracker Work Log

v0.2.1

Security

Peer Dependency

• Bump ace-builds from 1.4.13 to 1.4.14 Tracker Work Log
• Bump firebase from 9.0.2 to 9.6.10 Tracker Work Log
• Bump monaco-editor from 0.27.0 to 0.33.0 Tracker Work Log

Dev Dependency

• Bump api-extractor from 7.19.3 to 7.20.0 Tracker Work Log
• Bump babel-jest from 27.4.5 to 27.5.1 Tracker Work Log
• Bump canvas from 2.8.0 to 2.9.1 Tracker Work Log
• Bump firebase-tools from 9.23.3 to 10.6.0 Tracker Work Log
• Bump jest from 27.4.5 to 27.5.1 Tracker Work Log
• Bump lint-staged from 11.2.6 to 12.3.7 Tracker Work Log
• Bump preset-env from 7.16.5 to 7.16.11 Tracker Work Log
• Bump prettier from 2.5.1 to 2.6.2 Tracker Work Log
• Bump ts-loader from 9.2.6 to 9.2.8 Tracker Work Log
• Bump typescript from 4.5.4 to 4.6.3 Tracker Work Log
• Bump webpack from 5.65.0 to 5.71.0 Tracker Work Log
• Bump webpack-cli from 4.9.1 to 4.9.2 Tracker Work Log

v0.2.0

Added

• Add package @otjs/firebase-plaintext that implements Database Adapter interface for Plain Text Editor using Firebase Realtime Database as source of truth. Tracker Work Log
• Add package @otjs/ace that implements Editor Adapter interface for Plain Text Editor using Ace Editor instance as presentation. Tracker Work Log
• Add package @otjs/monaco that implements Editor Adapter interface for Plain Text Editor using Monaco Editor instance as presentation. Tracker Work Log
• Add package @otjs/firebase-monaco that integrates Firebase and Monaco adapter out of the box to create standalone package ready to be used. Tracker Work Log
• Add Cursor Widget in Ace Adapter to hightlight User Name beside cursor whenever a change is being made. Tracker Work Log
• Add Cursor Widget in Monaco Adapter to hightlight User Name beside cursor whenever a change is being made. Tracker Work Log
• Add Integration Test suite for @otjs/ace. Tracker Work Log

Changed

• Rename package scope to @otjs/*. Tracker Work Log
• Update @otjs/firebase-ace with API for User Name announcement. Tracker Work Log

Fixed

• Classname for Remote Cursor or Selection for Ace Editor. Tracker Work Log
• Classname for Remote Cursor or Selection for Monaco Editor. Tracker Work Log
• Missing testcase for @otjs/ace Integration Test suite. Tracker Work Log

Security

• Bump tmpl from 1.0.4 to 1.0.5 Work Log

Documentation

• Add LICENSE Information to root README. Tracker Work Log
• Integrated Codecov.io to track progress over Test workflow. Tracker Work Log
• Add Bug Reporting instructions to each package documentation. Tracker Work Log
• Update root README along with Version & Dependency matrix for all packages. Tracker Work Log
• Update documentation in each package. Tracker Work Log
• Add Code of Conduct for the community guidelines. Tracker Work Log
• Add Contributing Guidelines for the community engagement. Tracker Work Log
• Fix hyperlinks in Contributing Guidelines. Tracker Work Log
• Add Security Guidelines to report vulnerabilities. Tracker Work Log
• Add Issue and Pull Request guidelines for the community engagement. Tracker Work Log
• Add README for example use-case of @otjs/* packages as Realtime Collaborative Editor. Tracker Work Log

v0.1.1

Fixed

• Enable usage of the library in both Web (Browsers) and Node. Change library.globalObject to use this in Webpack Config. Tracker Work Log

v0.1.0

Added

• Add package @operational-transformation/plaintext that Handles Trannsformation Logic related to Plain Text content and content changes.
• Add package @operational-transformation/plaintext-editor that Handles integration between a Plain Text Editor and a Central Server, and keeps contents of all Plain Text Editors associated with the Central Server in sync via Plain Text Operational Transformations.
• Add package @operational-transformation/state-machine that Handles State Transitions and Side Effects in each stages of Synchronization between Client (e.g., Editor) and Server.