@plannotator/web-highlighter 0.8.0

package/.cursor/environment.json

@@ -0,0 +1,6 @@
+{
+  "snapshot": "snapshot-20250519-c7915489-4453-40ca-9eea-6e52326ce452",
+  "install": "",
+  "start": "",
+  "terminals": []
+}

package/.eslintrc.js

@@ -0,0 +1,250 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+  },
+  plugins: [
+    '@typescript-eslint/eslint-plugin',
+    'prettier',
+    'import',
+  ],
+  extends: [
+    "eslint:all",
+    'plugin:@typescript-eslint/all',
+    'prettier',
+    'prettier/@typescript-eslint',
+  ],
+  root: true,
+  env: {
+    es6: true,
+    node: true,
+    jest: true,
+  },
+  rules: {
+    "array-bracket-newline": [
+      "error",
+      "consistent"
+    ],
+    "array-element-newline": [
+      "error",
+      "consistent"
+    ],
+    "arrow-parens": [
+      "error",
+      "as-needed"
+    ],
+    "class-methods-use-this": "off",
+    "capitalized-comments": "off",
+    "comma-dangle": [
+      "error",
+      "always-multiline"
+    ],
+    "dot-location": [
+      "error",
+      "property"
+    ],
+    "func-names": [
+      "error",
+      "as-needed"
+    ],
+    "id-length": "off",
+    "implicit-arrow-linebreak": "off",
+    "init-declarations": "off",
+    "max-len": [
+      "error",
+      120
+    ],
+    "max-lines": "off",
+    "max-lines-per-function": "off",
+    "max-params": "off",
+    "max-statements": "off",
+    "multiline-comment-style": "off",
+    "multiline-ternary": [
+      "error",
+      "always-multiline"
+    ],
+    "newline-per-chained-call": [
+      "error",
+      {
+        "ignoreChainWithDepth": 2
+      }
+    ],
+    "no-await-in-loop": "off",
+    "no-bitwise": "off",
+    "no-confusing-arrow": "off",
+    "no-constant-condition": [
+      "error",
+      {
+        "checkLoops": false
+      }
+    ],
+    "no-continue": "off",
+    "no-duplicate-imports": "off",
+    "no-param-reassign": "off",
+    "no-underscore-dangle": "off",
+    "import/no-duplicates": [
+      "error",
+      {
+        "considerQueryString": true
+      }
+    ],
+    "no-empty": "off",
+    "no-implicit-coercion": "off",
+    "no-invalid-this": "off",
+    "no-mixed-operators": "off",
+    "no-multiple-empty-lines": [
+      "error",
+      {
+        "max": 2,
+        "maxEOF": 1
+      }
+    ],
+    "no-plusplus": [
+      "error",
+      {
+        "allowForLoopAfterthoughts": true
+      }
+    ],
+    "no-process-env": "off",
+    "no-shadow": "off",
+    "no-ternary": "off",
+    "no-unused-expressions": "off",
+    "no-warning-comments": "off",
+    "new-cap": "off",
+    "one-var": [
+      "error",
+      "never"
+    ],
+    "padded-blocks": [
+      "error",
+      "never"
+    ],
+    "padding-line-between-statements": [
+      "error",
+      {
+        "blankLine": "always",
+        "prev": [
+          "const",
+          "let",
+          "var"
+        ],
+        "next": "*"
+      },
+      {
+        "blankLine": "always",
+        "prev": "*",
+        "next": [
+          "const",
+          "let",
+          "var"
+        ]
+      },
+      {
+        "blankLine": "any",
+        "prev": [
+          "const",
+          "let",
+          "var"
+        ],
+        "next": [
+          "const",
+          "let",
+          "var"
+        ]
+      },
+      {
+        "blankLine": "always",
+        "prev": "*",
+        "next": "return"
+      },
+      {
+        "blankLine": "always",
+        "prev": "block-like",
+        "next": "*"
+      },
+      {
+        "blankLine": "always",
+        "prev": "*",
+        "next": "block-like"
+      }
+    ],
+    "prefer-destructuring": "off",
+    "quote-props": [
+      "error",
+      "as-needed"
+    ],
+    "quotes": [
+      "error",
+      "single",
+      {
+        "avoidEscape": true
+      }
+    ],
+    "object-curly-spacing": [
+      "error",
+      "always"
+    ],
+    "require-atomic-updates": "off",
+    "require-unicode-regexp": "off",
+    "semi": "off",
+    "sort-imports": "off",
+    "sort-keys": "off",
+    "wrap-regex": "off",
+    "import/default": "off",
+
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/explicit-member-accessibility": [
+      "error",
+      {
+        "accessibility": "no-public"
+      }
+    ],
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/generic-type-naming": "off",
+    "@typescript-eslint/init-declarations": "off",
+    "@typescript-eslint/naming-convention": "off",
+    "@typescript-eslint/no-dynamic-delete": "off",
+    "@typescript-eslint/no-empty-function": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-extraneous-class": [
+      "error",
+      {
+        "allowWithDecorator": true
+      }
+    ],
+    "@typescript-eslint/no-invalid-this": "off",
+    "@typescript-eslint/no-invalid-void-type": "off",
+    "@typescript-eslint/no-magic-numbers": "off",
+    "@typescript-eslint/no-misused-promises": "off",
+    "@typescript-eslint/no-parameter-properties": "off",
+    "@typescript-eslint/no-throw-literal": "off",
+    "@typescript-eslint/no-type-alias": "off",
+    "@typescript-eslint/no-unnecessary-condition": "off",
+    "@typescript-eslint/no-unsafe-assignment": "off",
+    "@typescript-eslint/no-unused-expressions": "off",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        "argsIgnorePattern": "^_$",
+        "varsIgnorePattern": "^_$",
+        "ignoreRestSiblings": true
+      }
+    ],
+    "@typescript-eslint/prefer-includes": "off",
+    "@typescript-eslint/prefer-nullish-coalescing": "off",
+    "@typescript-eslint/prefer-readonly-parameter-types": "off",
+    "@typescript-eslint/prefer-string-starts-ends-with": "off",
+    "@typescript-eslint/promise-function-async": "off",
+    "@typescript-eslint/restrict-template-expressions": [
+      "warn",
+      {
+        "allowNumber": true
+      }
+    ],
+    "@typescript-eslint/semi": "error",
+    "@typescript-eslint/strict-boolean-expressions": "off",
+    "@typescript-eslint/typedef": "off",
+    "prettier/prettier": "error"
+  },
+};

package/.prettierrc

@@ -0,0 +1,9 @@
+{
+    "singleQuote": true,
+    "trailingComma": "all",
+    "printWidth": 120,
+    "tabWidth": 4,
+    "arrowParens": "avoid",
+    "bracketSpacing": true,
+    "parser": "typescript"
+}

package/.travis.yml

@@ -0,0 +1,17 @@
+language: node_js
+
+node_js:
+  - 10
+
+branches:
+  only:
+    - master
+
+install:
+  - npm install
+
+script:
+  - npm run build
+  - npm run coverage
+
+after_script: "cat coverage/lcov.info | node_modules/coveralls/bin/coveralls.js"

package/CHANGELOG.md

@@ -0,0 +1,220 @@
+# CHANGELOG
+
+## v0.7.4
+
+### Fix
+
+Removing unsupported APIs to fix compatibility issues in IE11:
+
+- [Array.prototype.includes](https://caniuse.com/array-includes)
+- [String: startsWith](https://caniuse.com/mdn-javascript_builtins_string_startswith)
+- [RegExp: unicode](https://caniuse.com/mdn-javascript_builtins_regexp_unicode)
+
+---
+
+## v0.7.3
+
+### Fix
+
+- highlight wrapper inside another wrapper not get updated when deleting [#80](https://github.com/alienzhou/web-highlighter/pull/80)
+- make the className the latest one when wrapping a partial or an overlap node [#82](https://github.com/alienzhou/web-highlighter/pull/82)
+
+### Improvement
+
+- better typings for event emitter [#81](https://github.com/alienzhou/web-highlighter/pull/81)
+- tsconfig path alias and npm scripts [#84](https://github.com/alienzhou/web-highlighter/pull/84)
+
+---
+
+## v0.7.2
+
+### Fix
+
+- including type declarations in the `package.json`
+- making public `.options` a private field
+
+---
+
+## v0.7.1
+
+### Features
+
+- Generating .d.ts files for projects using typescript.
+
+### Fix
+
+- Select the range's container element correctly when it is not Text/Comment/CDATASection.
+
+---
+
+## v0.7.0
+
+### Features
+
+- Make get id methods more flexible.
+  - It will get correct id(s) inside a wrapper. No need to be a wrapper element.
+  - It is limited in the root scope.
+
+### Fix
+
+- Retain the wrapper's classname when wrapping a partial node.
+
+---
+
+## v0.6.0
+
+### Features
+
+- Add `.getExtraIdByDom` instance method which helps get extra ids from a wrapper.
+- Add a new hook: `Serialize.Restore`. You can use it to customize your own restoring method. When you tap this hook, the HighlightSource instance will use the function you pass to calculate the start and end nodes' info.
+- Support remove function in hooks. Now `hook.tap()` will return a function for removing it. Besides, you can also call `hook.remove()` to remove a tapped function.
+
+### Fix
+
+- When pre&next nodes are empty texts, the text node's wrapper should not be split.
+- Avoid add duplicate functions to a hook.
+
+### Other updates
+
+- Add unit tests for hook, event emitter and new features.
+- Use unknown type instead of any.
+
+---
+
+## v0.5.2
+
+### Features
+
+- Support verbose configuration. It decides whether warning&error message will be output.
+- Add a static method .isHighlightWrapNode(). You can use it to test whether a node(DOM) is a highlight wrapper.
+
+### Fix
+
+- Prevent emit REMOVE event when no node is affected by calling `.remove()` and `.removeAll()`
+- Fix the bug in `.getAll`, now it will return correct data
+- Prevent injecting duplicate stylesheets when one has been injected
+
+### Other updates
+
+- Add a suit of unit tests to ensure the code quality.
+- Refactor the way of error reporting.
+- Remove `.dataset` polyfill.
+
+---
+
+## v0.5.1
+
+### Fix
+
+- fix the bug: When the root node has no children (except text nodes), the highlights can't be recreate by sources.
+
+## v0.6.0-beta.0
+
+### Features
+
+- add a new hook: Serialize.Restore
+
+> Customize your own restoring method. When you tap this hook, the HighlightSource instance will use the function you pass to calculate the start and end nodes' info.
+
+---
+
+## v0.5.0
+
+### Features
+
+- add an option: support changing the default wrapper's tag name
+
+using it as below
+
+```typescript
+const highlighter = new Highlighter({
+    wrapTag: 'b'
+});
+```
+
+---
+
+## 0.4.0-beta.0
+
+### Features
+
+- support highlighting on mobile devices:
+  - automatically detect whether mobile devices
+  - use touch events when on mobile devices
+
+### Other updates
+
+- source code: provide some internal methods for dom operation
+- example app: bugfix & update
+
+---
+
+## v0.3.5
+
+### Fix
+
+- Bugfix: The highlighter.removeAll() method doesn't work
+
+---
+
+## v0.3.4
+
+### Fix
+
+- bugfix: `highlighter.removeAll()` does not work properly
+
+---
+
+## v0.3.3
+
+### Fix
+
+- hook: Remove.UpdateNode --> Remove.UpdateNodes
+
+### Other update
+
+- docs: english version
+- use new README for the example
+
+---
+
+## v0.3.2
+
+### Updates
+
+- refactor: split some painter's functions
+- update: update docs and the example
+
+---
+
+## v0.3.1
+
+### Updates
+
+- Structure refactor
+- Handling compatibility issues
+- Remove unnecessary modules
+
+---
+
+## v0.0.3
+
+### Features
+
+- support setting config dynamically
+
+### Break Changes
+
+- rename `.render()` to `.fromSource()`
+- rename `.highlight()` to `.fromRange()`
+- remove `.init` method and `highlight:init` event
+
+---
+
+## v0.0.2
+
+### Features
+
+- set highlight style (class) by id
+- get highlight position info (offsetTop, offsetLeft)
+- highlighting web text by passing range manually

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Alien ZHOU
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.