Squire upgraded to v2.3

This commit is contained in:
Mohammad Rezaei 2024-09-11 12:49:29 +03:30
parent 0db6c6ab5f
commit a6a83fa2df
68 changed files with 15220 additions and 0 deletions

568
vendors/dompurify/LICENSE vendored Normal file
View file

@ -0,0 +1,568 @@
DOMPurify
Copyright 2024 Dr.-Ing. Mario Heiderich, Cure53
DOMPurify is free software; you can redistribute it and/or modify it under the
terms of either:
a) the Apache License Version 2.0, or
b) the Mozilla Public License Version 2.0
-----------------------------------------------------------------------------
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-----------------------------------------------------------------------------
Mozilla Public License, version 2.0
1. Definitions
1.1. “Contributor”
means each individual or legal entity that creates, contributes to the
creation of, or owns Covered Software.
1.2. “Contributor Version”
means the combination of the Contributions of others (if any) used by a
Contributor and that particular Contributors Contribution.
1.3. “Contribution”
means Covered Software of a particular Contributor.
1.4. “Covered Software”
means Source Code Form to which the initial Contributor has attached the
notice in Exhibit A, the Executable Form of such Source Code Form, and
Modifications of such Source Code Form, in each case including portions
thereof.
1.5. “Incompatible With Secondary Licenses”
means
a. that the initial Contributor has attached the notice described in
Exhibit B to the Covered Software; or
b. that the Covered Software was made available under the terms of version
1.1 or earlier of the License, but not also under the terms of a
Secondary License.
1.6. “Executable Form”
means any form of the work other than Source Code Form.
1.7. “Larger Work”
means a work that combines Covered Software with other material, in a separate
file or files, that is not Covered Software.
1.8. “License”
means this document.
1.9. “Licensable”
means having the right to grant, to the maximum extent possible, whether at the
time of the initial grant or subsequently, any and all of the rights conveyed by
this License.
1.10. “Modifications”
means any of the following:
a. any file in Source Code Form that results from an addition to, deletion
from, or modification of the contents of Covered Software; or
b. any new file in Source Code Form that contains any Covered Software.
1.11. “Patent Claims” of a Contributor
means any patent claim(s), including without limitation, method, process,
and apparatus claims, in any patent Licensable by such Contributor that
would be infringed, but for the grant of the License, by the making,
using, selling, offering for sale, having made, import, or transfer of
either its Contributions or its Contributor Version.
1.12. “Secondary License”
means either the GNU General Public License, Version 2.0, the GNU Lesser
General Public License, Version 2.1, the GNU Affero General Public
License, Version 3.0, or any later versions of those licenses.
1.13. “Source Code Form”
means the form of the work preferred for making modifications.
1.14. “You” (or “Your”)
means an individual or a legal entity exercising rights under this
License. For legal entities, “You” includes any entity that controls, is
controlled by, or is under common control with You. For purposes of this
definition, “control” means (a) the power, direct or indirect, to cause
the direction or management of such entity, whether by contract or
otherwise, or (b) ownership of more than fifty percent (50%) of the
outstanding shares or beneficial ownership of such entity.
2. License Grants and Conditions
2.1. Grants
Each Contributor hereby grants You a world-wide, royalty-free,
non-exclusive license:
a. under intellectual property rights (other than patent or trademark)
Licensable by such Contributor to use, reproduce, make available,
modify, display, perform, distribute, and otherwise exploit its
Contributions, either on an unmodified basis, with Modifications, or as
part of a Larger Work; and
b. under Patent Claims of such Contributor to make, use, sell, offer for
sale, have made, import, and otherwise transfer either its Contributions
or its Contributor Version.
2.2. Effective Date
The licenses granted in Section 2.1 with respect to any Contribution become
effective for each Contribution on the date the Contributor first distributes
such Contribution.
2.3. Limitations on Grant Scope
The licenses granted in this Section 2 are the only rights granted under this
License. No additional rights or licenses will be implied from the distribution
or licensing of Covered Software under this License. Notwithstanding Section
2.1(b) above, no patent license is granted by a Contributor:
a. for any code that a Contributor has removed from Covered Software; or
b. for infringements caused by: (i) Your and any other third partys
modifications of Covered Software, or (ii) the combination of its
Contributions with other software (except as part of its Contributor
Version); or
c. under Patent Claims infringed by Covered Software in the absence of its
Contributions.
This License does not grant any rights in the trademarks, service marks, or
logos of any Contributor (except as may be necessary to comply with the
notice requirements in Section 3.4).
2.4. Subsequent Licenses
No Contributor makes additional grants as a result of Your choice to
distribute the Covered Software under a subsequent version of this License
(see Section 10.2) or under the terms of a Secondary License (if permitted
under the terms of Section 3.3).
2.5. Representation
Each Contributor represents that the Contributor believes its Contributions
are its original creation(s) or it has sufficient rights to grant the
rights to its Contributions conveyed by this License.
2.6. Fair Use
This License is not intended to limit any rights You have under applicable
copyright doctrines of fair use, fair dealing, or other equivalents.
2.7. Conditions
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
Section 2.1.
3. Responsibilities
3.1. Distribution of Source Form
All distribution of Covered Software in Source Code Form, including any
Modifications that You create or to which You contribute, must be under the
terms of this License. You must inform recipients that the Source Code Form
of the Covered Software is governed by the terms of this License, and how
they can obtain a copy of this License. You may not attempt to alter or
restrict the recipients rights in the Source Code Form.
3.2. Distribution of Executable Form
If You distribute Covered Software in Executable Form then:
a. such Covered Software must also be made available in Source Code Form,
as described in Section 3.1, and You must inform recipients of the
Executable Form how they can obtain a copy of such Source Code Form by
reasonable means in a timely manner, at a charge no more than the cost
of distribution to the recipient; and
b. You may distribute such Executable Form under the terms of this License,
or sublicense it under different terms, provided that the license for
the Executable Form does not attempt to limit or alter the recipients
rights in the Source Code Form under this License.
3.3. Distribution of a Larger Work
You may create and distribute a Larger Work under terms of Your choice,
provided that You also comply with the requirements of this License for the
Covered Software. If the Larger Work is a combination of Covered Software
with a work governed by one or more Secondary Licenses, and the Covered
Software is not Incompatible With Secondary Licenses, this License permits
You to additionally distribute such Covered Software under the terms of
such Secondary License(s), so that the recipient of the Larger Work may, at
their option, further distribute the Covered Software under the terms of
either this License or such Secondary License(s).
3.4. Notices
You may not remove or alter the substance of any license notices (including
copyright notices, patent notices, disclaimers of warranty, or limitations
of liability) contained within the Source Code Form of the Covered
Software, except that You may alter any license notices to the extent
required to remedy known factual inaccuracies.
3.5. Application of Additional Terms
You may choose to offer, and to charge a fee for, warranty, support,
indemnity or liability obligations to one or more recipients of Covered
Software. However, You may do so only on Your own behalf, and not on behalf
of any Contributor. You must make it absolutely clear that any such
warranty, support, indemnity, or liability obligation is offered by You
alone, and You hereby agree to indemnify every Contributor for any
liability incurred by such Contributor as a result of warranty, support,
indemnity or liability terms You offer. You may include additional
disclaimers of warranty and limitations of liability specific to any
jurisdiction.
4. Inability to Comply Due to Statute or Regulation
If it is impossible for You to comply with any of the terms of this License
with respect to some or all of the Covered Software due to statute, judicial
order, or regulation then You must: (a) comply with the terms of this License
to the maximum extent possible; and (b) describe the limitations and the code
they affect. Such description must be placed in a text file included with all
distributions of the Covered Software under this License. Except to the
extent prohibited by statute or regulation, such description must be
sufficiently detailed for a recipient of ordinary skill to be able to
understand it.
5. Termination
5.1. The rights granted under this License will terminate automatically if You
fail to comply with any of its terms. However, if You become compliant,
then the rights granted under this License from a particular Contributor
are reinstated (a) provisionally, unless and until such Contributor
explicitly and finally terminates Your grants, and (b) on an ongoing basis,
if such Contributor fails to notify You of the non-compliance by some
reasonable means prior to 60 days after You have come back into compliance.
Moreover, Your grants from a particular Contributor are reinstated on an
ongoing basis if such Contributor notifies You of the non-compliance by
some reasonable means, this is the first time You have received notice of
non-compliance with this License from such Contributor, and You become
compliant prior to 30 days after Your receipt of the notice.
5.2. If You initiate litigation against any entity by asserting a patent
infringement claim (excluding declaratory judgment actions, counter-claims,
and cross-claims) alleging that a Contributor Version directly or
indirectly infringes any patent, then the rights granted to You by any and
all Contributors for the Covered Software under Section 2.1 of this License
shall terminate.
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
license agreements (excluding distributors and resellers) which have been
validly granted by You or Your distributors under this License prior to
termination shall survive termination.
6. Disclaimer of Warranty
Covered Software is provided under this License on an “as is” basis, without
warranty of any kind, either expressed, implied, or statutory, including,
without limitation, warranties that the Covered Software is free of defects,
merchantable, fit for a particular purpose or non-infringing. The entire
risk as to the quality and performance of the Covered Software is with You.
Should any Covered Software prove defective in any respect, You (not any
Contributor) assume the cost of any necessary servicing, repair, or
correction. This disclaimer of warranty constitutes an essential part of this
License. No use of any Covered Software is authorized under this License
except under this disclaimer.
7. Limitation of Liability
Under no circumstances and under no legal theory, whether tort (including
negligence), contract, or otherwise, shall any Contributor, or anyone who
distributes Covered Software as permitted above, be liable to You for any
direct, indirect, special, incidental, or consequential damages of any
character including, without limitation, damages for lost profits, loss of
goodwill, work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses, even if such party shall have been
informed of the possibility of such damages. This limitation of liability
shall not apply to liability for death or personal injury resulting from such
partys negligence to the extent applicable law prohibits such limitation.
Some jurisdictions do not allow the exclusion or limitation of incidental or
consequential damages, so this exclusion and limitation may not apply to You.
8. Litigation
Any litigation relating to this License may be brought only in the courts of
a jurisdiction where the defendant maintains its principal place of business
and such litigation shall be governed by laws of that jurisdiction, without
reference to its conflict-of-law provisions. Nothing in this Section shall
prevent a partys ability to bring cross-claims or counter-claims.
9. Miscellaneous
This License represents the complete agreement concerning the subject matter
hereof. If any provision of this License is held to be unenforceable, such
provision shall be reformed only to the extent necessary to make it
enforceable. Any law or regulation which provides that the language of a
contract shall be construed against the drafter shall not be used to construe
this License against a Contributor.
10. Versions of the License
10.1. New Versions
Mozilla Foundation is the license steward. Except as provided in Section
10.3, no one other than the license steward has the right to modify or
publish new versions of this License. Each version will be given a
distinguishing version number.
10.2. Effect of New Versions
You may distribute the Covered Software under the terms of the version of
the License under which You originally received the Covered Software, or
under the terms of any subsequent version published by the license
steward.
10.3. Modified Versions
If you create software not governed by this License, and you want to
create a new license for such software, you may create and use a modified
version of this License if you rename the license and remove any
references to the name of the license steward (except to note that such
modified license differs from this License).
10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
If You choose to distribute Source Code Form that is Incompatible With
Secondary Licenses under the terms of this version of the License, the
notice described in Exhibit B of this License must be attached.
Exhibit A - Source Code Form License Notice
This Source Code Form is subject to the
terms of the Mozilla Public License, v.
2.0. If a copy of the MPL was not
distributed with this file, You can
obtain one at
http://mozilla.org/MPL/2.0/.
If it is not possible or desirable to put the notice in a particular file, then
You may include the notice in a location (such as a LICENSE file in a relevant
directory) where a recipient would be likely to look for such a notice.
You may add additional accurate notices of copyright ownership.
Exhibit B - “Incompatible With Secondary Licenses” Notice
This Source Code Form is “Incompatible
With Secondary Licenses”, as defined by
the Mozilla Public License, v. 2.0.

442
vendors/dompurify/README.md vendored Normal file
View file

@ -0,0 +1,442 @@
# DOMPurify
[![npm version](https://badge.fury.io/js/dompurify.svg)](http://badge.fury.io/js/dompurify) ![Build and Test](https://github.com/cure53/DOMPurify/workflows/Build%20and%20Test/badge.svg?branch=main) [![Downloads](https://img.shields.io/npm/dm/dompurify.svg)](https://www.npmjs.com/package/dompurify) ![npm package minimized gzipped size (select exports)](https://img.shields.io/bundlejs/size/dompurify?color=%233C1&label=minified) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/cure53/dompurify?color=%233C1) [![dependents](https://badgen.net/github/dependents-repo/cure53/dompurify?color=green&label=dependents)](https://github.com/cure53/DOMPurify/network/dependents)
[![NPM](https://nodei.co/npm/dompurify.png)](https://nodei.co/npm/dompurify/)
DOMPurify is a DOM-only, super-fast, uber-tolerant XSS sanitizer for HTML, MathML and SVG.
It's also very simple to use and get started with. DOMPurify was [started in February 2014](https://github.com/cure53/DOMPurify/commit/a630922616927373485e0e787ab19e73e3691b2b) and, meanwhile, has reached version **v3.1.6**.
DOMPurify is written in JavaScript and works in all modern browsers (Safari (10+), Opera (15+), Edge, Firefox and Chrome - as well as almost anything else using Blink, Gecko or WebKit). It doesn't break on MSIE or other legacy browsers. It simply does nothing.
**Note that [DOMPurify v2.5.6](https://github.com/cure53/DOMPurify/releases/tag/2.5.6) is the latest version supporting MSIE. For important security updates compatible with MSIE, please use the [2.x branch](https://github.com/cure53/DOMPurify/tree/2.x).**
Our automated tests cover [19 different browsers](https://github.com/cure53/DOMPurify/blob/main/test/karma.custom-launchers.config.js#L5) right now, more to come. We also cover Node.js v16.x, v17.x, v18.x and v19.x, running DOMPurify on [jsdom](https://github.com/jsdom/jsdom). Older Node versions are known to work as well, but hey... no guarantees.
DOMPurify is written by security people who have vast background in web attacks and XSS. Fear not. For more details please also read about our [Security Goals & Threat Model](https://github.com/cure53/DOMPurify/wiki/Security-Goals-&-Threat-Model). Please, read it. Like, really.
## What does it do?
DOMPurify sanitizes HTML and prevents XSS attacks. You can feed DOMPurify with string full of dirty HTML and it will return a string (unless configured otherwise) with clean HTML. DOMPurify will strip out everything that contains dangerous HTML and thereby prevent XSS attacks and other nastiness. It's also damn bloody fast. We use the technologies the browser provides and turn them into an XSS filter. The faster your browser, the faster DOMPurify will be.
## How do I use it?
It's easy. Just include DOMPurify on your website.
### Using the unminified development version
```html
<script type="text/javascript" src="src/purify.js"></script>
```
### Using the minified and tested production version (source-map available)
```html
<script type="text/javascript" src="dist/purify.min.js"></script>
```
Afterwards you can sanitize strings by executing the following code:
```js
const clean = DOMPurify.sanitize(dirty);
```
Or maybe this, if you love working with Angular or alike:
```js
import DOMPurify from 'dompurify';
const clean = DOMPurify.sanitize('<b>hello there</b>');
```
The resulting HTML can be written into a DOM element using `innerHTML` or the DOM using `document.write()`. That is fully up to you.
Note that by default, we permit HTML, SVG **and** MathML. If you only need HTML, which might be a very common use-case, you can easily set that up as well:
```js
const clean = DOMPurify.sanitize(dirty, { USE_PROFILES: { html: true } });
```
### Where are the TypeScript type definitions?
They can be found here: [@types/dompurify](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/dompurify)
### Is there any foot-gun potential?
Well, please note, if you _first_ sanitize HTML and then modify it _afterwards_, you might easily **void the effects of sanitization**. If you feed the sanitized markup to another library _after_ sanitization, please be certain that the library doesn't mess around with the HTML on its own.
### Okay, makes sense, let's move on
After sanitizing your markup, you can also have a look at the property `DOMPurify.removed` and find out, what elements and attributes were thrown out. Please **do not use** this property for making any security critical decisions. This is just a little helper for curious minds.
### Running DOMPurify on the server
DOMPurify technically also works server-side with Node.js. Our support strives to follow the [Node.js release cycle](https://nodejs.org/en/about/releases/).
Running DOMPurify on the server requires a DOM to be present, which is probably no surprise. Usually, [jsdom](https://github.com/jsdom/jsdom) is the tool of choice and we **strongly recommend** to use the latest version of _jsdom_.
Why? Because older versions of _jsdom_ are known to be buggy in ways that result in XSS _even if_ DOMPurify does everything 100% correctly. There are **known attack vectors** in, e.g. _jsdom v19.0.0_ that are fixed in _jsdom v20.0.0_ - and we really recommend to keep _jsdom_ up to date because of that.
Please also be aware that tools like [happy-dom](https://github.com/capricorn86/happy-dom) exist but **are not considered safe** at this point. Combining DOMPurify with _happy-dom_ is currently not recommended and will likely lead to XSS.
Other than that, you are fine to use DOMPurify on the server. Probably. This really depends on _jsdom_ or whatever DOM you utilize server-side. If you can live with that, this is how you get it to work:
```bash
npm install dompurify
npm install jsdom
```
For _jsdom_ (please use an up-to-date version), this should do the trick:
```js
const createDOMPurify = require('dompurify');
const { JSDOM } = require('jsdom');
const window = new JSDOM('').window;
const DOMPurify = createDOMPurify(window);
const clean = DOMPurify.sanitize('<b>hello there</b>');
```
Or even this, if you prefer working with imports:
```js
import { JSDOM } from 'jsdom';
import DOMPurify from 'dompurify';
const window = new JSDOM('').window;
const purify = DOMPurify(window);
const clean = purify.sanitize('<b>hello there</b>');
```
If you have problems making it work in your specific setup, consider looking at the amazing [isomorphic-dompurify](https://github.com/kkomelin/isomorphic-dompurify) project which solves lots of problems people might run into.
```bash
npm install isomorphic-dompurify
```
```js
import DOMPurify from 'isomorphic-dompurify';
const clean = DOMPurify.sanitize('<s>hello</s>');
```
## Is there a demo?
Of course there is a demo! [Play with DOMPurify](https://cure53.de/purify)
## What if I find a _security_ bug?
First of all, please immediately contact us via [email](mailto:mario@cure53.de) so we can work on a fix. [PGP key](https://keyserver.ubuntu.com/pks/lookup?op=vindex&search=0xC26C858090F70ADA)
Also, you probably qualify for a bug bounty! The fine folks over at [Fastmail](https://www.fastmail.com/) use DOMPurify for their services and added our library to their bug bounty scope. So, if you find a way to bypass or weaken DOMPurify, please also have a look at their website and the [bug bounty info](https://www.fastmail.com/about/bugbounty/).
## Some purification samples please?
How does purified markup look like? Well, [the demo](https://cure53.de/purify) shows it for a big bunch of nasty elements. But let's also show some smaller examples!
```js
DOMPurify.sanitize('<img src=x onerror=alert(1)//>'); // becomes <img src="x">
DOMPurify.sanitize('<svg><g/onload=alert(2)//<p>'); // becomes <svg><g></g></svg>
DOMPurify.sanitize('<p>abc<iframe//src=jAva&Tab;script:alert(3)>def</p>'); // becomes <p>abc</p>
DOMPurify.sanitize('<math><mi//xlink:href="data:x,<script>alert(4)</script>">'); // becomes <math><mi></mi></math>
DOMPurify.sanitize('<TABLE><tr><td>HELLO</tr></TABL>'); // becomes <table><tbody><tr><td>HELLO</td></tr></tbody></table>
DOMPurify.sanitize('<UL><li><A HREF=//google.com>click</UL>'); // becomes <ul><li><a href="//google.com">click</a></li></ul>
```
## What is supported?
DOMPurify currently supports HTML5, SVG and MathML. DOMPurify per default allows CSS, HTML custom data attributes. DOMPurify also supports the Shadow DOM - and sanitizes DOM templates recursively. DOMPurify also allows you to sanitize HTML for being used with the jQuery `$()` and `elm.html()` API without any known problems.
## What about legacy browsers like Internet Explorer?
DOMPurify does nothing at all. It simply returns exactly the string that you fed it. DOMPurify exposes a property called `isSupported`, which tells you whether it will be able to do its job, so you can come up with your own backup plan.
## What about DOMPurify and Trusted Types?
In version 1.0.9, support for [Trusted Types API](https://github.com/w3c/webappsec-trusted-types) was added to DOMPurify.
In version 2.0.0, a config flag was added to control DOMPurify's behavior regarding this.
When `DOMPurify.sanitize` is used in an environment where the Trusted Types API is available and `RETURN_TRUSTED_TYPE` is set to `true`, it tries to return a `TrustedHTML` value instead of a string (the behavior for `RETURN_DOM` and `RETURN_DOM_FRAGMENT` config options does not change).
Note that in order to create a policy in `trustedTypes` using DOMPurify, `RETURN_TRUSTED_TYPE: false` is required, as `createHTML` expects a normal string, not `TrustedHTML`. The example below shows this.
```js
window.trustedTypes!.createPolicy('default', {
createHTML: (to_escape) =>
DOMPurify.sanitize(to_escape, { RETURN_TRUSTED_TYPE: false }),
});
```
## Can I configure DOMPurify?
Yes. The included default configuration values are pretty good already - but you can of course override them. Check out the [`/demos`](https://github.com/cure53/DOMPurify/tree/main/demos) folder to see a bunch of examples on how you can [customize DOMPurify](https://github.com/cure53/DOMPurify/tree/main/demos#what-is-this).
### General settings
```js
// strip {{ ... }}, ${ ... } and <% ... %> to make output safe for template systems
// be careful please, this mode is not recommended for production usage.
// allowing template parsing in user-controlled HTML is not advised at all.
// only use this mode if there is really no alternative.
const clean = DOMPurify.sanitize(dirty, {SAFE_FOR_TEMPLATES: true});
// change how e.g. comments containing risky HTML characters are treated.
// be very careful, this setting should only be set to `false` if you really only handle
// HTML and nothing else, no SVG, MathML or the like.
// Otherwise, changing from `true` to `false` will lead to XSS in this or some other way.
const clean = DOMPurify.sanitize(dirty, {SAFE_FOR_XML: false});
```
### Control our allow-lists and block-lists
```js
// allow only <b> elements, very strict
const clean = DOMPurify.sanitize(dirty, {ALLOWED_TAGS: ['b']});
// allow only <b> and <q> with style attributes
const clean = DOMPurify.sanitize(dirty, {ALLOWED_TAGS: ['b', 'q'], ALLOWED_ATTR: ['style']});
// allow all safe HTML elements but neither SVG nor MathML
// note that the USE_PROFILES setting will override the ALLOWED_TAGS setting
// so don't use them together
const clean = DOMPurify.sanitize(dirty, {USE_PROFILES: {html: true}});
// allow all safe SVG elements and SVG Filters, no HTML or MathML
const clean = DOMPurify.sanitize(dirty, {USE_PROFILES: {svg: true, svgFilters: true}});
// allow all safe MathML elements and SVG, but no SVG Filters
const clean = DOMPurify.sanitize(dirty, {USE_PROFILES: {mathMl: true, svg: true}});
// change the default namespace from HTML to something different
const clean = DOMPurify.sanitize(dirty, {NAMESPACE: 'http://www.w3.org/2000/svg'});
// leave all safe HTML as it is and add <style> elements to block-list
const clean = DOMPurify.sanitize(dirty, {FORBID_TAGS: ['style']});
// leave all safe HTML as it is and add style attributes to block-list
const clean = DOMPurify.sanitize(dirty, {FORBID_ATTR: ['style']});
// extend the existing array of allowed tags and add <my-tag> to allow-list
const clean = DOMPurify.sanitize(dirty, {ADD_TAGS: ['my-tag']});
// extend the existing array of allowed attributes and add my-attr to allow-list
const clean = DOMPurify.sanitize(dirty, {ADD_ATTR: ['my-attr']});
// prohibit ARIA attributes, leave other safe HTML as is (default is true)
const clean = DOMPurify.sanitize(dirty, {ALLOW_ARIA_ATTR: false});
// prohibit HTML5 data attributes, leave other safe HTML as is (default is true)
const clean = DOMPurify.sanitize(dirty, {ALLOW_DATA_ATTR: false});
```
### Control behavior relating to Custom Elements
```js
// DOMPurify allows to define rules for Custom Elements. When using the CUSTOM_ELEMENT_HANDLING
// literal, it is possible to define exactly what elements you wish to allow (by default, none are allowed).
//
// The same goes for their attributes. By default, the built-in or configured allow.list is used.
//
// You can use a RegExp literal to specify what is allowed or a predicate, examples for both can be seen below.
// The default values are very restrictive to prevent accidental XSS bypasses. Handle with great care!
const clean = DOMPurify.sanitize(
'<foo-bar baz="foobar" forbidden="true"></foo-bar><div is="foo-baz"></div>',
{
CUSTOM_ELEMENT_HANDLING: {
tagNameCheck: null, // no custom elements are allowed
attributeNameCheck: null, // default / standard attribute allow-list is used
allowCustomizedBuiltInElements: false, // no customized built-ins allowed
},
}
); // <div is=""></div>
const clean = DOMPurify.sanitize(
'<foo-bar baz="foobar" forbidden="true"></foo-bar><div is="foo-baz"></div>',
{
CUSTOM_ELEMENT_HANDLING: {
tagNameCheck: /^foo-/, // allow all tags starting with "foo-"
attributeNameCheck: /baz/, // allow all attributes containing "baz"
allowCustomizedBuiltInElements: true, // customized built-ins are allowed
},
}
); // <foo-bar baz="foobar"></foo-bar><div is="foo-baz"></div>
const clean = DOMPurify.sanitize(
'<foo-bar baz="foobar" forbidden="true"></foo-bar><div is="foo-baz"></div>',
{
CUSTOM_ELEMENT_HANDLING: {
tagNameCheck: (tagName) => tagName.match(/^foo-/), // allow all tags starting with "foo-"
attributeNameCheck: (attr) => attr.match(/baz/), // allow all containing "baz"
allowCustomizedBuiltInElements: true, // allow customized built-ins
},
}
); // <foo-bar baz="foobar"></foo-bar><div is="foo-baz"></div>
```
### Control behavior relating to URI values
```js
// extend the existing array of elements that can use Data URIs
const clean = DOMPurify.sanitize(dirty, {ADD_DATA_URI_TAGS: ['a', 'area']});
// extend the existing array of elements that are safe for URI-like values (be careful, XSS risk)
const clean = DOMPurify.sanitize(dirty, {ADD_URI_SAFE_ATTR: ['my-attr']});
```
### Control permitted attribute values
```js
// allow external protocol handlers in URL attributes (default is false, be careful, XSS risk)
// by default only http, https, ftp, ftps, tel, mailto, callto, sms, cid and xmpp are allowed.
const clean = DOMPurify.sanitize(dirty, {ALLOW_UNKNOWN_PROTOCOLS: true});
// allow specific protocols handlers in URL attributes via regex (default is false, be careful, XSS risk)
// by default only http, https, ftp, ftps, tel, mailto, callto, sms, cid and xmpp are allowed.
// Default RegExp: /^(?:(?:(?:f|ht)tps?|mailto|tel|callto|sms|cid|xmpp):|[^a-z]|[a-z+.\-]+(?:[^a-z+.\-:]|$))/i;
const clean = DOMPurify.sanitize(dirty, {ALLOWED_URI_REGEXP: /^(?:(?:(?:f|ht)tps?|mailto|tel|callto|sms|cid|xmpp|xxx):|[^a-z]|[a-z+.\-]+(?:[^a-z+.\-:]|$))/i});
```
### Influence the return-type
```js
// return a DOM HTMLBodyElement instead of an HTML string (default is false)
const clean = DOMPurify.sanitize(dirty, {RETURN_DOM: true});
// return a DOM DocumentFragment instead of an HTML string (default is false)
const clean = DOMPurify.sanitize(dirty, {RETURN_DOM_FRAGMENT: true});
// use the RETURN_TRUSTED_TYPE flag to turn on Trusted Types support if available
const clean = DOMPurify.sanitize(dirty, {RETURN_TRUSTED_TYPE: true}); // will return a TrustedHTML object instead of a string if possible
// use a provided Trusted Types policy
const clean = DOMPurify.sanitize(dirty, {
// supplied policy must define createHTML and createScriptURL
TRUSTED_TYPES_POLICY: trustedTypes.createPolicy({
createHTML(s) { return s},
createScriptURL(s) { return s},
}
});
```
### Influence how we sanitize
```js
// return entire document including <html> tags (default is false)
const clean = DOMPurify.sanitize(dirty, {WHOLE_DOCUMENT: true});
// disable DOM Clobbering protection on output (default is true, handle with care, minor XSS risks here)
const clean = DOMPurify.sanitize(dirty, {SANITIZE_DOM: false});
// enforce strict DOM Clobbering protection via namespace isolation (default is false)
// when enabled, isolates the namespace of named properties (i.e., `id` and `name` attributes)
// from JS variables by prefixing them with the string `user-content-`
const clean = DOMPurify.sanitize(dirty, {SANITIZE_NAMED_PROPS: true});
// keep an element's content when the element is removed (default is true)
const clean = DOMPurify.sanitize(dirty, {KEEP_CONTENT: false});
// glue elements like style, script or others to document.body and prevent unintuitive browser behavior in several edge-cases (default is false)
const clean = DOMPurify.sanitize(dirty, {FORCE_BODY: true});
// remove all <a> elements under <p> elements that are removed
const clean = DOMPurify.sanitize(dirty, {FORBID_CONTENTS: ['a'], FORBID_TAGS: ['p']});
// change the parser type so sanitized data is treated as XML and not as HTML, which is the default
const clean = DOMPurify.sanitize(dirty, {PARSER_MEDIA_TYPE: 'application/xhtml+xml'});
```
### Influence where we sanitize
```js
// use the IN_PLACE mode to sanitize a node "in place", which is much faster depending on how you use DOMPurify
const dirty = document.createElement('a');
dirty.setAttribute('href', 'javascript:alert(1)');
const clean = DOMPurify.sanitize(dirty, {IN_PLACE: true}); // see https://github.com/cure53/DOMPurify/issues/288 for more info
```
There is even [more examples here](https://github.com/cure53/DOMPurify/tree/main/demos#what-is-this), showing how you can run, customize and configure DOMPurify to fit your needs.
## Persistent Configuration
Instead of repeatedly passing the same configuration to `DOMPurify.sanitize`, you can use the `DOMPurify.setConfig` method. Your configuration will persist until your next call to `DOMPurify.setConfig`, or until you invoke `DOMPurify.clearConfig` to reset it. Remember that there is only one active configuration, which means once it is set, all extra configuration parameters passed to `DOMPurify.sanitize` are ignored.
## Hooks
DOMPurify allows you to augment its functionality by attaching one or more functions with the `DOMPurify.addHook` method to one of the following hooks:
- `beforeSanitizeElements`
- `uponSanitizeElement` (No 's' - called for every element)
- `afterSanitizeElements`
- `beforeSanitizeAttributes`
- `uponSanitizeAttribute`
- `afterSanitizeAttributes`
- `beforeSanitizeShadowDOM`
- `uponSanitizeShadowNode`
- `afterSanitizeShadowDOM`
It passes the currently processed DOM node, when needed a literal with verified node and attribute data and the DOMPurify configuration to the callback. Check out the [MentalJS hook demo](https://github.com/cure53/DOMPurify/blob/main/demos/hooks-mentaljs-demo.html) to see how the API can be used nicely.
_Example_:
```js
DOMPurify.addHook(
'uponSanitizeAttribute',
function (currentNode, hookEvent, config) {
// Do something with the current node
// You can also mutate hookEvent for current node (i.e. set hookEvent.forceKeepAttr = true)
// For other than 'uponSanitizeAttribute' hook types hookEvent equals to null
}
);
```
## Removed Configuration
| Option | Since | Note |
|-----------------|-------|--------------------------|
| SAFE_FOR_JQUERY | 2.1.0 | No replacement required. |
## Continuous Integration
We are currently using Github Actions in combination with BrowserStack. This gives us the possibility to confirm for each and every commit that all is going according to plan in all supported browsers. Check out the build logs here: https://github.com/cure53/DOMPurify/actions
You can further run local tests by executing `npm test`. The tests work fine with Node.js v0.6.2 and jsdom@8.5.0.
All relevant commits will be signed with the key `0x24BB6BF4` for additional security (since 8th of April 2016).
### Development and contributing
#### Installation (`npm i`)
We support `npm` officially. GitHub Actions workflow is configured to install dependencies using `npm`. When using deprecated version of `npm` we can not fully ensure the versions of installed dependencies which might lead to unanticipated problems.
#### Scripts
We rely on npm run-scripts for integrating with our tooling infrastructure. We use ESLint as a pre-commit hook to ensure code consistency. Moreover, to ease formatting we use [prettier](https://github.com/prettier/prettier) while building the `/dist` assets happens through `rollup`.
These are our npm scripts:
- `npm run dev` to start building while watching sources for changes
- `npm run test` to run our test suite via jsdom and karma
- `test:jsdom` to only run tests through jsdom
- `test:karma` to only run tests through karma
- `npm run lint` to lint the sources using ESLint (via xo)
- `npm run format` to format our sources using prettier to ease to pass ESLint
- `npm run build` to build our distribution assets minified and unminified as a UMD module
- `npm run build:umd` to only build an unminified UMD module
- `npm run build:umd:min` to only build a minified UMD module
Note: all run scripts triggered via `npm run <script>`.
There are more npm scripts but they are mainly to integrate with CI or are meant to be "private" for instance to amend build distribution files with every commit.
## Security Mailing List
We maintain a mailing list that notifies whenever a security-critical release of DOMPurify was published. This means, if someone found a bypass and we fixed it with a release (which always happens when a bypass was found) a mail will go out to that list. This usually happens within minutes or few hours after learning about a bypass. The list can be subscribed to here:
[https://lists.ruhr-uni-bochum.de/mailman/listinfo/dompurify-security](https://lists.ruhr-uni-bochum.de/mailman/listinfo/dompurify-security)
Feature releases will not be announced to this list.
## Who contributed?
Many people helped and help DOMPurify become what it is and need to be acknowledged here!
[hash_kitten ❤️](https://twitter.com/hash_kitten), [kevin_mizu ❤️](https://twitter.com/kevin_mizu), [icesfont ❤️](https://github.com/icesfont) [dcramer 💸](https://github.com/dcramer), [JGraph 💸](https://github.com/jgraph), [baekilda 💸](https://github.com/baekilda), [Healthchecks 💸](https://github.com/healthchecks), [Sentry 💸](https://github.com/getsentry), [jarrodldavis 💸](https://github.com/jarrodldavis), [CynegeticIO](https://github.com/CynegeticIO), [ssi02014 ❤️](https://github.com/ssi02014), [GrantGryczan](https://github.com/GrantGryczan), [Lowdefy](https://twitter.com/lowdefy), [granlem](https://twitter.com/MaximeVeit), [oreoshake](https://github.com/oreoshake), [tdeekens ❤️](https://github.com/tdeekens), [peernohell ❤️](https://github.com/peernohell), [is2ei](https://github.com/is2ei), [SoheilKhodayari](https://github.com/SoheilKhodayari), [franktopel](https://github.com/franktopel), [NateScarlet](https://github.com/NateScarlet), [neilj](https://github.com/neilj), [fhemberger](https://github.com/fhemberger), [Joris-van-der-Wel](https://github.com/Joris-van-der-Wel), [ydaniv](https://github.com/ydaniv), [terjanq](https://twitter.com/terjanq), [filedescriptor](https://github.com/filedescriptor), [ConradIrwin](https://github.com/ConradIrwin), [gibson042](https://github.com/gibson042), [choumx](https://github.com/choumx), [0xSobky](https://github.com/0xSobky), [styfle](https://github.com/styfle), [koto](https://github.com/koto), [tlau88](https://github.com/tlau88), [strugee](https://github.com/strugee), [oparoz](https://github.com/oparoz), [mathiasbynens](https://github.com/mathiasbynens), [edg2s](https://github.com/edg2s), [dnkolegov](https://github.com/dnkolegov), [dhardtke](https://github.com/dhardtke), [wirehead](https://github.com/wirehead), [thorn0](https://github.com/thorn0), [styu](https://github.com/styu), [mozfreddyb](https://github.com/mozfreddyb), [mikesamuel](https://github.com/mikesamuel), [jorangreef](https://github.com/jorangreef), [jimmyhchan](https://github.com/jimmyhchan), [jameydeorio](https://github.com/jameydeorio), [jameskraus](https://github.com/jameskraus), [hyderali](https://github.com/hyderali), [hansottowirtz](https://github.com/hansottowirtz), [hackvertor](https://github.com/hackvertor), [freddyb](https://github.com/freddyb), [flavorjones](https://github.com/flavorjones), [djfarrelly](https://github.com/djfarrelly), [devd](https://github.com/devd), [camerondunford](https://github.com/camerondunford), [buu700](https://github.com/buu700), [buildog](https://github.com/buildog), [alabiaga](https://github.com/alabiaga), [Vector919](https://github.com/Vector919), [Robbert](https://github.com/Robbert), [GreLI](https://github.com/GreLI), [FuzzySockets](https://github.com/FuzzySockets), [ArtemBernatskyy](https://github.com/ArtemBernatskyy), [@garethheyes](https://twitter.com/garethheyes), [@shafigullin](https://twitter.com/shafigullin), [@mmrupp](https://twitter.com/mmrupp), [@irsdl](https://twitter.com/irsdl),[ShikariSenpai](https://github.com/ShikariSenpai), [ansjdnakjdnajkd](https://github.com/ansjdnakjdnajkd), [@asutherland](https://twitter.com/asutherland), [@mathias](https://twitter.com/mathias), [@cgvwzq](https://twitter.com/cgvwzq), [@robbertatwork](https://twitter.com/robbertatwork), [@giutro](https://twitter.com/giutro), [@CmdEngineer\_](https://twitter.com/CmdEngineer_), [@avr4mit](https://twitter.com/avr4mit) and especially [@securitymb ❤️](https://twitter.com/securitymb) & [@masatokinugawa ❤️](https://twitter.com/masatokinugawa)
## Testing powered by
<a target="_blank" href="https://www.browserstack.com/"><img width="200" src="https://github.com/cure53/DOMPurify/assets/6709482/f70be7eb-8fc4-41ea-9653-9d359235328f"></a><br>
And last but not least, thanks to [BrowserStack Open-Source Program](https://www.browserstack.com/open-source) for supporting this project with their services for free and delivering excellent, dedicated and very professional support on top of that.

1556
vendors/dompurify/dist/purify.cjs.js vendored Normal file

File diff suppressed because it is too large Load diff

File diff suppressed because one or more lines are too long

1554
vendors/dompurify/dist/purify.es.mjs vendored Normal file

File diff suppressed because it is too large Load diff

File diff suppressed because one or more lines are too long

1562
vendors/dompurify/dist/purify.js vendored Normal file

File diff suppressed because it is too large Load diff

1
vendors/dompurify/dist/purify.js.map vendored Normal file

File diff suppressed because one or more lines are too long

3
vendors/dompurify/dist/purify.min.js vendored Normal file

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

128
vendors/dompurify/package.json vendored Normal file
View file

@ -0,0 +1,128 @@
{
"scripts": {
"lint": "xo src/*.js",
"format": "npm run format:js && npm run format:md",
"format:md": "prettier --write --parser markdown '**/*.md'",
"format:js": "prettier --write '{src,demos,scripts,test,website}/*.js'",
"commit-amend-build": "scripts/commit-amend-build.sh",
"prebuild": "rimraf dist/**",
"dev": "cross-env NODE_ENV=development BABEL_ENV=rollup rollup -w -c -o dist/purify.js",
"build": "rollup -c",
"build:umd": "rollup -c -f umd -o dist/purify.js",
"build:umd:min": "rollup -c -f umd -o dist/purify.min.js -p terser",
"build:es": "rollup -c -f es -o dist/purify.es.mjs",
"build:cjs": "rollup -c -f cjs -o dist/purify.cjs.js",
"test:jsdom": "cross-env NODE_ENV=test BABEL_ENV=rollup node test/jsdom-node-runner --dot",
"test:karma": "cross-env NODE_ENV=test BABEL_ENV=rollup karma start test/karma.conf.js --log-level warn ",
"test:ci": "cross-env NODE_ENV=test BABEL_ENV=rollup npm run test:jsdom && npm run test:karma -- --log-level error --reporters dots --single-run --shouldTestOnBrowserStack=\"${TEST_BROWSERSTACK}\" --shouldProbeOnly=\"${TEST_PROBE_ONLY}\"",
"test": "cross-env NODE_ENV=test BABEL_ENV=rollup npm run lint && npm run test:jsdom && npm run test:karma -- --browsers Chrome"
},
"main": "./dist/purify.cjs.js",
"module": "./dist/purify.es.mjs",
"browser": "./dist/purify.js",
"production": "./dist/purify.min.js",
"files": [
"dist"
],
"pre-commit": [
"lint",
"build",
"commit-amend-build"
],
"xo": {
"semicolon": true,
"space": 2,
"extends": [
"prettier"
],
"plugins": [
"prettier"
],
"rules": {
"import/no-useless-path-segments": 0,
"unicorn/prefer-optional-catch-binding": 0,
"unicorn/prefer-node-remove": 0,
"prettier/prettier": [
"error",
{
"trailingComma": "es5",
"singleQuote": true
}
],
"camelcase": [
"error",
{
"properties": "never"
}
]
},
"globals": [
"window",
"VERSION"
]
},
"devDependencies": {
"@babel/core": "^7.17.8",
"@babel/preset-env": "^7.16.11",
"@rollup/plugin-babel": "^5.3.1",
"@rollup/plugin-node-resolve": "^13.1.3",
"@rollup/plugin-replace": "^4.0.0",
"@types/dompurify": "^2.3.3",
"@types/estree": "^1.0.0",
"cross-env": "^7.0.3",
"eslint-config-prettier": "^8.5.0",
"eslint-plugin-prettier": "^4.0.0",
"jquery": "^3.6.0",
"jsdom": "^20.0.0",
"karma": "^6.3.17",
"karma-browserstack-launcher": "^1.5.1",
"karma-chrome-launcher": "^3.1.0",
"karma-firefox-launcher": "^2.1.2",
"karma-qunit": "^4.1.2",
"karma-rollup-preprocessor": "^7.0.8",
"lodash.sample": "^4.2.1",
"minimist": "^1.2.6",
"npm-run-all": "^4.1.5",
"pre-commit": "^1.2.2",
"prettier": "^2.5.1",
"qunit": "^2.4.1",
"qunit-tap": "^1.5.0",
"rimraf": "^3.0.2",
"rollup": "^2.70.1",
"rollup-plugin-includepaths": "^0.2.3",
"rollup-plugin-terser": "^7.0.2",
"xo": "^0.54.1"
},
"resolutions": {
"natives": "1.1.6"
},
"name": "dompurify",
"description": "DOMPurify is a DOM-only, super-fast, uber-tolerant XSS sanitizer for HTML, MathML and SVG. It's written in JavaScript and works in all modern browsers (Safari, Opera (15+), Internet Explorer (10+), Firefox and Chrome - as well as almost anything else using Blink or WebKit). DOMPurify is written by security people who have vast background in web attacks and XSS. Fear not.",
"version": "3.1.6",
"directories": {
"test": "test"
},
"repository": {
"type": "git",
"url": "git://github.com/cure53/DOMPurify.git"
},
"keywords": [
"dom",
"xss",
"html",
"svg",
"mathml",
"security",
"secure",
"sanitizer",
"sanitize",
"filter",
"purify"
],
"author": "Dr.-Ing. Mario Heiderich, Cure53 <mario@cure53.de> (https://cure53.de/)",
"license": "(MPL-2.0 OR Apache-2.0)",
"bugs": {
"url": "https://github.com/cure53/DOMPurify/issues"
},
"homepage": "https://github.com/cure53/DOMPurify"
}

204
vendors/squire-rte/CHANGELOG.md vendored Normal file
View file

@ -0,0 +1,204 @@
# Changelog
All notable changes to this project will be documented in this file, starting from v2.0.0.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [2.3.1] - 2024-07-23
### Fixed
- Fix crash extracting contents of range.
## [2.3.0] - 2024-07-18
### Fixed
- Fix text nodes sometimes incorrectly merged after delete.
### Added
- HTML copied from the editor now includes a `<!-- squire -->` comment
- The willPaste event now includes an `html` property in the details, with the
raw HTML that is being pasted.
## [2.2.9] - 2024-07-17
### Fixed
- Fix incorrect styles can be applied after splitting at the end of inline
formatting, blurring, and focusing again.
- Fix font info sometimes not returned even when selection within a single
text span.
## [2.2.8] - 2024-02-21
### Fixed
- Fix some keyboard shortcuts not working on some platforms.
- Fix unable to paste text with new line on Android.
## [2.2.7] - 2024-02-21
### Fixed
- Fix handling of Japanese IME input.
- Fix willPaste event not cancelable.
## [2.2.6] - 2024-02-01
### Fixed
- Fix Firefox cursor position after paste.
- Fix keyboard handling on some Android browsers
### Added
- Add undo point for automatic list creation.
## [2.2.5] - 2023-11-08
### Fixed
- Return focus to the editor after undo/redo.
## [2.2.4] - 2023-10-24
### Fixed
- Fixed the type definition of the "setKeyHandler" method "key" parameter.
## [2.2.3] - 2023-10-09
### Fixed
- Fixed a null-deref crash that could occur when removing inline formatting.
## [2.2.2] - 2023-10-04
### Fixed
- Added a workaround for a bug in Chrome that resulted in text in the editor
not being rendered in certain circumstances.
## [2.2.1] - 2023-10-03
### Fixed
- Fixed a bug in the exported extractRangeToClipboard fn if used in a certain
configuration.
## [2.2.0] - 2023-10-02
### Added
- The Squire config now has support for a toPlainText function, that takes an
HTML string and should return the plain text version of that content to be
added to the clipboard when cutting/copying.
### Changed
- The default conversion of the HTML to plain text when cutting/copying now
uses the same algorithm as the getSelectedText method.
## [2.1.1] - 2023-09-27
### Fixed
- If you changed inline formatting in Chrome and then hit space, the formatting
would be lost. This is now fixed.
## [2.1.0] - 2023-09-19
### Added
- If you start a new line with "\*" then a space, Squire will now automatically
set the format to an unordered list.
- If you start a new line with "1." then a space, Squire will now automatically
set the format to an ordered list.
## [2.0.3] - 2023-04-20
### Fixed
- Fixed an error being thrown when you typed a URL in the middle of a text
node. https://github.com/fastmail/Squire/issues/430
## [2.0.2] - 2023-03-20
### Changed
- Let ArrowRight key always break out of <code> if at end. It will add a
space afterwards if needed.
- Added documentation for pasteImage event.
### Fixed
- Fix backspace can delete two characters.
- Consistently focus after calling removeAllFormatting.
- Performance improvements.
## [2.0.1] - 2023-02-14
### Changed
- Auto delink if backspacing inside auto-linked URL. This means if you make a
mistake and backspace, you don't end up accidentally fixing the text but
leaving the link to the wrong URL.
### Fixed
- Fix duplicate CSS created when replacing styles
- Support browsers without Selection#setBaseAndExtent API. This includes some
older Firefox versions.
## [2.0.0] - 2023-01-23
### Added
- Builds as an ES module.
### Changed
- All code ported to Typescript and ES modules for compatibility with modern
frontend projects and future maintainability.
- New off-the-shelf tooling for the build process and code quality assurance.
- Config option `sanitizeToDOMFragment` no longer takes an `isPaste`
argument.
- Custom events (e.g. `pathChange`) use the browser native CustomEvent class,
which means the custom properties (e.g. `path`) are now available on the
`detail` property of the event object, rather than directly added to the
event object.
- When the user pastes an image, instead of simulating drag/drop events,
Squire now fires a custom `pasteImage` event, with a `clipboardData`
property on the `detail`
- When there is a selection and you paste text that looks like a URL, it will
now make the selection a link rather than replacing it with the URL text.
- In the object returned by the `getFontInfo` method, the font size property
is now called "fontSize" instead of "size", and the font family property is
now called "fontFamily" instead of "family". This means all properties now
use the same name as in the CSSStyleDeclaration API.
- The `key` function for setKeyHandler now uses the same names
(including case) as the KeyboardEvent.key property
(https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key).
For example, `"enter"` is now `"Enter"` and `"left"` is now `"ArrowLeft"`.
### Fixed
- Fixed iOS autocorrect/text substitution fails to activate when hitting
"enter".
- Fixed Samsung keyboard on Android causes bizarre changes to the input,
making it unusable.
- Fixed bug trimming insignificant trailing white space, which could result
in some formatting actions behaving oddly.
- Fixed spaces "vanish" sometimes after deleting text.
### Removed
- Support for any version of IE.
- Support for using an iframe document as the editor, rather than just a
normal DOM node.
- Support for using it without an HTML sanitiser - this is essential for
security, so it's now required.
- `isInsertedHTMLSanitized` and `isSetHTMLSanitized` config options - as per
the above, the HTML is always sanitised on insertion for security.

21
vendors/squire-rte/LICENSE vendored Normal file
View file

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright © 20112023 by Neil Jenkins
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.

478
vendors/squire-rte/README.md vendored Normal file
View file

@ -0,0 +1,478 @@
# Squire
Squire is an HTML5 rich text editor, which provides powerful cross-browser normalisation in a flexible lightweight package (only 16KB of JS after minification and gzip, with no dependencies!).
It was designed to handle email composition for the [Fastmail](https://www.fastmail.com) web app. The most important consequence of this (and where Squire differs from most other modern rich text editors) is that it must handle arbitrary HTML, because it may be used to forward or quote emails from third-parties and must be able to preserve their HTML without breaking the formatting. This means that it can't use a more structured (but limited) internal data model (as most other modern HTML editors do) and the HTML remains the source-of-truth. The other consequence is excellent handling of multiple levels of blockquotes.
Squire is designed to be integrated with your own UI framework, and so does not provide its own UI toolbar, widgets or overlays. Instead, you get a component you can insert in place of a `<textarea>` and manipulate programmatically, allowing you to integrate seamlessly with the rest of your application and lose the bloat of having two UI toolkits loaded.
Squire supports all reasonably recent browsers. It no longer supports any version of IE.
In addition to its use at [Fastmail](https://www.fastmail.com), it is also currently used in production at [ProtonMail](https://protonmail.com/), [SnappyMail](https://github.com/the-djmaze/snappymail), [StartMail](https://startmail.com/), [Tutanota](https://tutanota.com), [Zoho Mail](https://www.zoho.com/mail/), [Superhuman](https://superhuman.com/) and [Teamwork Desk](https://www.teamwork.com/desk/), as well as other non-mail apps including [Google Earth](https://www.google.com/earth/) (drop me a line if you're using Squire elsewhere, I'm always interested to hear about it!).
For a demo of the latest version with a production-level UI integration, [sign up for a free Fastmail trial](https://www.fastmail.com/signup/) :). There's also a very bare-bones integration in the repo; just clone it and open `Demo.html`. If you are reporting a bug, please report the steps to reproduce using `Demo.html`, to make sure it's not a bug in your integration.
## Installation and usage
1. Add Squire to your project: `npm install squire-rte`
2. In your code, `import Squire from 'squire-rte';`
3. Create your editor by calling `editor = new Squire(node);`.
### Invoke with script tag
Squire can also be used in a script tag:
1. Add a `<script>` tag to load in `dist/squire.js` (or `squire-raw.js` for the debuggable unminified version):
```
<script type="text/javascript" src="dist/squire.js"></script>
```
2. Get a reference to the DOM node in the document that you want to make into the rich textarea, e.g. `node = document.getElementById('editor-div')`.
3. Call `editor = new Squire(node)`. This will instantiate a new Squire instance. Please note, this will remove any current children of the node; you must use the `setHTML` command after initialising to set any content.
## Editor lifecycle
You can have multiple Squire instances in a single page without issue. If you are using the editor as part of a long lived single-page app, be sure to call `editor.destroy()` once you have finished using an instance to ensure it doesn't leak resources.
### Security
Malicious HTML can be a source of XSS and other security issues. You MUST provide a method to safely convert raw HTML into DOM nodes to use Squire. Squire will automatically integrate with [DOMPurify](https://github.com/cure53/DOMPurify) to do this if present in the page. Otherwise you must set a custom `sanitizeToDOMFragment` function in your config.
- **sanitizeToDOMFragment**: `(html: string, editor: Squire) => DocumentFragment`
A custom sanitization function. This will be called instead of the default call to DOMPurify to sanitize the potentially dangerous HTML. It is passed two arguments: the first is the string of HTML, the second is the Squire instance. It must return a DOM Fragment node belonging to the same document as the editor's root node, with the contents being clean DOM nodes to set/insert.
## Advanced usage
Squire provides an engine that handles the heavy work for you, making it easy to add extra features. With the `changeFormat` method you can easily add or remove any inline formatting you wish. And the `modifyBlocks` method can be used to make complicated block-level changes in a relatively easy manner.
If you need more commands than in the simple API, I suggest you check out the source code (it's not very long), and see how a lot of the other API methods are implemented in terms of these two methods.
The general philosophy of Squire is to allow the browser to do as much as it can (which unfortunately is not very much), but take control anywhere it deviates from what is required, or there are significant cross-browser differences. As such, the [`document.execCommand`](https://developer.mozilla.org/en-US/docs/Web/API/Document/execCommand) method is not used at all; instead all formatting is done via custom functions, and certain keys, such as 'enter' and 'backspace' are handled by the editor.
### Setting the default block style
By default, the editor will use a `<div>` for blank lines, as most users have been conditioned by Microsoft Word to expect <kbd>Enter</kbd> to act like pressing <kbd>return</kbd> on a typewriter. If you would like to use `<p>` tags (or anything else) for the default block type instead, you can pass a config object as the second parameter to the Squire constructor. You can also
pass a set of attributes to apply to each default block:
var editor = new Squire(document, {
blockTag: 'P',
blockAttributes: { style: 'font-size: 16px;' }
});
### Determining button state
If you are adding a UI to Squire, you'll probably want to show a button in different states depending on whether a particular style is active in the current selection or not. For example, a "Bold" button would be in a depressed state if the text under the cursor is already bold.
The efficient way to determine the state for most buttons is to monitor the "pathChange" event in the editor, and determine the state from the new path. If the selection goes across nodes, you will need to call the `hasFormat` method for each of your buttons to determine whether the styles are active. See the `getPath` and `hasFormat` documentation for more information.
## License
Squire is released under the MIT license. See LICENSE for full license.
## API
### addEventListener
Attach an event listener to the editor. The handler can be either a function or an object with a `handleEvent` method. This function or method will be called whenever the event fires, with an event object as the sole argument. The following events may be observed:
- **focus**: The editor gained focus.
- **blur**: The editor lost focus
- **keydown**: Standard [DOM keydown event](https://developer.mozilla.org/en-US/docs/Web/Events/keydown).
- **keypress**: Standard [DOM keypress event](https://developer.mozilla.org/en-US/docs/Web/Events/keypress).
- **keyup**: Standard [DOM keyup event](https://developer.mozilla.org/en-US/docs/Web/Events/keyup).
- **input**: The user inserted, deleted or changed the style of some text; in other words, the result for `editor.getHTML()` will have changed.
- **pathChange**: The path (see getPath documentation) to the cursor has changed. The new path is available as the `path` property on the event's `detail` property object.
- **select**: The user selected some text.
- **cursor**: The user cleared their selection or moved the cursor to a different position.
- **undoStateChange**: The availability of undo and/or redo has changed. The event object has a `detail` property, which is an object with two boolean properties, `canUndo` and `canRedo` to let you know the new state.
- **willPaste**: The user is pasting content into the document. The content that will be inserted is available as either the `fragment` property, or the `text` property for plain text, on the `detail` property of the event. You can modify this text/fragment in your event handler to change what will be pasted. You can also call the `preventDefault` on the event object to cancel the paste operation.
- **pasteImage**: The user is pasting image content into the document.
The method takes two arguments:
- **type**: The event to listen for. e.g. 'focus'.
- **handler**: The callback function to invoke
Returns self (the Squire instance).
### removeEventListener
Remove an event listener attached via the addEventListener method.
The method takes two arguments:
- **type**: The event type the handler was registered for.
- **handler**: The handler to remove.
Returns self (the Squire instance).
### setKeyHandler
Adds or removes a keyboard shortcut. You can use this to override the default keyboard shortcuts (e.g. Ctrl-B for bold  see the bottom of KeyHandlers.js for the list).
This method takes two arguments:
- **key**: The key to handle, including any modifiers in alphabetical order. e.g. `"Alt-Ctrl-Meta-Shift-Enter"`
- **fn**: The function to be called when this key is pressed, or `null` if removing a key handler. The function will be passed three arguments when called:
- **self**: A reference to the Squire instance.
- **event**: The key event object.
- **range**: A Range object representing the current selection.
Returns self (the Squire instance).
### focus
Focuses the editor.
The method takes no arguments.
Returns self (the Squire instance).
### blur
Removes focus from the editor.
The method takes no arguments.
Returns self (the Squire instance).
### getHTML
Returns the HTML value of the editor in its current state. This value is equivalent to the contents of the `<body>` tag and does not include any surrounding boilerplate.
### setHTML
Sets the HTML value for the editor. The value supplied should not contain `<body>` tags or anything outside of that.
The method takes one argument:
- **html**: The html to set.
Returns self (the Squire instance).
### getSelectedText
Returns the text currently selected in the editor.
### insertImage
Inserts an image at the current cursor location.
The method takes two arguments:
- **src**: The source path for the image.
- **attributes**: (optional) An object containing other attributes to set on the `<img>` node. e.g. `{ class: 'class-name' }`. Any `src` attribute will be overwritten by the url given as the first argument.
Returns a reference to the newly inserted image element.
### insertHTML
Inserts an HTML fragment at the current cursor location, or replaces the selection if selected. The value supplied should not contain `<body>` tags or anything outside of that.
The method takes one argument:
- **html**: The html to insert.
Returns self (the Squire instance).
### getPath
Returns the path through the DOM tree from the `<body>` element to the current current cursor position. This is a string consisting of the tag, id, class, font, and color names in CSS format. For example `BODY>BLOCKQUOTE>DIV#id>STRONG>SPAN.font[fontFamily=Arial,sans-serif]>EM`. If a selection has been made, so different parts of the selection may have different paths, the value will be `(selection)`. The path is useful for efficiently determining the current formatting for bold, italic, underline etc, and thus determining button state. If a selection has been made, you can has the `hasFormat` method instead to get the current state for the properties you care about.
### getFontInfo
Returns an object containing the active font family, size, color and background color for the the current cursor position, if any are set. The property names are respectively `fontFamily`, `fontSize`, `color` and `backgroundColor` (matching the CSS property names). It looks at style attributes to detect this, so will not detect `<FONT>` tags or non-inline styles. If a selection across multiple elements has been made, it will return an empty object.
### createRange
Creates a range in the document belonging to the editor. Takes 4 arguments, matching the [W3C Range properties](https://developer.mozilla.org/en-US/docs/Web/API/Range) they set:
- **startContainer**
- **startOffset**
- **endContainer** (optional; if not collapsed)
- **endOffset** (optional; if not collapsed)
### getCursorPosition
Returns a bounding client rect (top/left/right/bottom properties relative to
the viewport) for the current selection/cursor.
### getSelection
Returns a [W3C Range object](https://developer.mozilla.org/en-US/docs/Web/API/Range) representing the current selection/cursor position.
### setSelection
Changes the current selection/cursor position.
The method takes one argument:
- **range**: The [W3C Range object](https://developer.mozilla.org/en-US/docs/Web/API/Range) representing the desired selection.
Returns self (the Squire instance).
### moveCursorToStart
Removes any current selection and moves the cursor to the very beginning of the
document.
Returns self (the Squire instance).
### moveCursorToEnd
Removes any current selection and moves the cursor to the very end of the
document.
Returns self (the Squire instance).
### saveUndoState
Saves an undo checkpoint with the current editor state. Methods that modify the
state (e.g. bold/setHighlightColor/modifyBlocks) will automatically save undo
checkpoints; you only need this method if you want to modify the DOM outside of
one of these methods, and you want to save an undo checkpoint first.
Returns self (the Squire instance).
### undo
Undoes the most recent change.
Returns self (the Squire instance).
### redo
If the user has just undone a change, this will reapply that change.
Returns self (the Squire instance).
### hasFormat
Queries the editor for whether a particular format is applied anywhere in the current selection.
The method takes two arguments:
- **tag**: The tag of the format
- **attributes**: (optional) Any attributes the format.
Returns `true` if the entire selection is contained within an element with the specified tag and attributes, otherwise returns `false`.
### bold
Makes any non-bold currently selected text bold (by wrapping it in a `<b>` tag).
Returns self (the Squire instance).
### italic
Makes any non-italic currently selected text italic (by wrapping it in an `<i>` tag).
Returns self (the Squire instance).
### underline
Makes any non-underlined currently selected text underlined (by wrapping it in a `<u>` tag).
Returns self (the Squire instance).
### removeBold
Removes any bold formatting from the selected text.
Returns self (the Squire instance).
### removeItalic
Removes any italic formatting from the selected text.
Returns self (the Squire instance).
### removeUnderline
Removes any underline formatting from the selected text.
Returns self (the Squire instance).
### makeLink
Makes the currently selected text a link. If no text is selected, the URL or email will be inserted as text at the current cursor point and made into a link.
This method takes two arguments:
- **url**: The url or email to link to.
- **attributes**: (optional) An object containing other attributes to set on the `<a>` node. e.g. `{ target: '_blank' }`. Any `href` attribute will be overwritten by the url given as the first argument.
Returns self (the Squire instance).
### removeLink
Removes any link that is currently at least partially selected.
Returns self (the Squire instance).
### setFontFace
Sets the font face for the selected text.
This method takes one argument:
- **font**: A comma-separated list of fonts (in order of preference) to set.
Returns self (the Squire instance).
### setFontSize
Sets the font size for the selected text.
This method takes one argument:
- **size**: A size to set. Any CSS [length value](https://developer.mozilla.org/en-US/docs/Web/CSS/length) or [absolute-size value](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_values_syntax#syntax-absolute-size) is accepted, e.g. '13px', or 'small'.
Returns self (the Squire instance).
### setTextColor
Sets the color of the selected text.
This method takes one argument:
- **color**: The color to set. Any [CSS color value](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) is accepted, e.g. '#f00', or 'hsl(0,0,0)'.
Returns self (the Squire instance).
### setHighlightColor
Sets the color of the background of the selected text.
This method takes one argument:
- **color**: The color to set. Any [CSS color value](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) is accepted, e.g. '#f00', or 'hsl(0,0,0)'.
Returns self (the Squire instance).
### setTextAlignment
Sets the text alignment in all blocks at least partially contained by the selection.
This method takes one argument:
- **alignment**: The direction to align to. Can be 'left', 'right', 'center' or 'justify'.
Returns self (the Squire instance).
### setTextDirection
Sets the text direction in all blocks at least partially contained by the selection.
This method takes one argument:
- **direction**: The text direction. Can be 'ltr' or 'rtl'.
Returns self (the Squire instance).
### forEachBlock
Executes a function on each block in the current selection, or until the function returns a truthy value.
This method takes two arguments:
- **fn** The function to execute on each block node at least partially contained in the current selection. The function will be called with the block node as the only argument.
- **mutates** A boolean indicating whether your function may modify anything in the document in any way.
Returns self (the Squire instance).
### modifyBlocks
Extracts a portion of the DOM tree (up to the block boundaries of the current selection), modifies it and then reinserts it and merges the edges. See the code for examples if you're interested in using this function.
This method takes one argument:
- **modify** The function to apply to the extracted DOM tree; gets a document fragment as a sole argument. `this` is bound to the Squire instance. Should return the node or fragment to be reinserted in the DOM.
Returns self (the Squire instance).
### increaseQuoteLevel
Increases by 1 the quote level (number of `<blockquote>` tags wrapping) all blocks at least partially selected.
Returns self (the Squire instance).
### decreaseQuoteLevel
Decreases by 1 the quote level (number of `<blockquote>` tags wrapping) all blocks at least partially selected.
Returns self (the Squire instance).
### makeUnorderedList
Changes all at-least-partially selected blocks to be part of an unordered list.
Returns self (the Squire instance).
### makeOrderedList
Changes all at-least-partially selected blocks to be part of an ordered list.
Returns self (the Squire instance).
### removeList
Changes any at-least-partially selected blocks which are part of a list to no longer be part of a list.
Returns self (the Squire instance).
### increaseListLevel
Increases by 1 the nesting level of any at-least-partially selected blocks which are part of a list.
Returns self (the Squire instance).
### decreaseListLevel
Decreases by 1 the nesting level of any at-least-partially selected blocks which are part of a list.
Returns self (the Squire instance).
### code
If no selection, or selection across blocks, converts the block to a `<pre>` to format the text as fixed-width. If a selection within a single block is present, wraps that in `<code>` tags for inline formatting instead.
Returns self (the Squire instance).
### removeCode
If inside a `<pre>`, converts that to the default block type instead. Otherwise, removes any `<code>` tags.
Returns self (the Squire instance).
### toggleCode
If inside a `<pre>` or `<code>`, calls `removeCode()`, otherwise callse `code()`.
Returns self (the Squire instance).
### removeAllFormatting
Removes all formatting from the selection. Block elements (list items, table cells, etc.) are kept as separate blocks.
Returns self (the Squire instance).
### changeFormat
Change the **inline** formatting of the current selection. This is a high-level method which is used to implement the bold, italic etc. helper methods. THIS METHOD IS ONLY FOR USE WITH INLINE TAGS, NOT BLOCK TAGS. It takes 4 arguments:
1. An object describing the formatting to add, or `null` if you only wish to remove formatting. If supplied, this object should have a `tag` property with the string name of the tag to wrap around the selected text (e.g. `"STRONG"`) and optionally an `attributes` property, consisting of an object of attributes to apply to the tag (e.g. `{"class": "bold"}`).
2. An object describing the formatting to remove, in the same format as the object given to add formatting, or `null` if you only wish to add formatting.
3. A Range object with the range to apply the formatting changes to (or `null`/omit to apply to current selection).
4. A boolean (defaults to `false` if omitted). If `true`, any formatting nodes that cover at least part of the selected range will be removed entirely (so will potentially be removed from text outside the selected range as well). If `false`, the formatting nodes will continue to apply to any text outside the selection. This is useful, for example, when removing links. If any of the text in the selection is part of a link, the whole link is removed, rather than the link continuing to apply to bits of text outside the selection.
### modifyDocument
Takes in a function that can modify the document without the modifications being treated as input.
This is useful when the document needs to be changed programmatically, but those changes should not raise input events or modify the undo state.
### linkRegExp
This is the regular expression used to automatically mark up links when inserting HTML or after pressing space. You can change it if you want to use a custom regular expression for detecting links, or set to `/[]/` to turn off link detection.

38
vendors/squire-rte/build.js vendored Executable file
View file

@ -0,0 +1,38 @@
#!/usr/bin/env node
import esbuild from 'esbuild';
Promise.all([
esbuild.build({
entryPoints: ['source/Legacy.ts'],
bundle: true,
target: 'es6',
format: 'iife',
outfile: 'dist/squire-raw.js',
}),
esbuild.build({
entryPoints: ['source/Legacy.ts'],
bundle: true,
minify: true,
sourcemap: 'linked',
target: 'es6',
format: 'iife',
outfile: 'dist/squire.js',
}),
esbuild.build({
entryPoints: ['source/Squire.ts'],
bundle: true,
target: 'esnext',
format: 'esm',
outfile: 'dist/squire-raw.mjs',
}),
esbuild.build({
entryPoints: ['source/Squire.ts'],
bundle: true,
minify: true,
sourcemap: 'linked',
target: 'esnext',
format: 'esm',
outfile: 'dist/squire.mjs',
}),
]).catch(() => process.exit(1));

4108
vendors/squire-rte/dist/squire-raw.js vendored Normal file

File diff suppressed because it is too large Load diff

4107
vendors/squire-rte/dist/squire-raw.mjs vendored Normal file

File diff suppressed because it is too large Load diff

11
vendors/squire-rte/dist/squire.js vendored Normal file

File diff suppressed because one or more lines are too long

7
vendors/squire-rte/dist/squire.js.map vendored Normal file

File diff suppressed because one or more lines are too long

11
vendors/squire-rte/dist/squire.mjs vendored Normal file

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,8 @@
import { isLineBreak } from './node/Whitespace';
import type { SquireConfig } from './Editor';
declare const cleanTree: (node: Node, config: SquireConfig, preserveWS?: boolean) => Node;
declare const removeEmptyInlines: (node: Node) => void;
declare const cleanupBRs: (node: Element | DocumentFragment, root: Element, keepForBlankLine: boolean) => void;
declare const escapeHTML: (text: string) => string;
export { cleanTree, cleanupBRs, isLineBreak, removeEmptyInlines, escapeHTML };
//# sourceMappingURL=Clean.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Clean.d.ts","sourceRoot":"","sources":["../../source/Clean.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAoN7C,QAAA,MAAM,SAAS,SACL,IAAI,UACF,YAAY,eACP,OAAO,KACrB,IA2FF,CAAC;AAIF,QAAA,MAAM,kBAAkB,SAAU,IAAI,KAAG,IAcxC,CAAC;AAUF,QAAA,MAAM,UAAU,SACN,OAAO,GAAG,gBAAgB,QAC1B,OAAO,oBACK,OAAO,KAC1B,IA8BF,CAAC;AAIF,QAAA,MAAM,UAAU,SAAU,MAAM,KAAG,MAUlC,CAAC;AAIF,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,kBAAkB,EAAE,UAAU,EAAE,CAAC"}

View file

@ -0,0 +1,9 @@
import type { Squire } from './Editor';
declare const extractRangeToClipboard: (event: ClipboardEvent, range: Range, root: HTMLElement, removeRangeFromDocument: boolean, toCleanHTML: null | ((html: string) => string), toPlainText: null | ((html: string) => string), plainTextOnly: boolean) => boolean;
declare const _onCut: (this: Squire, event: ClipboardEvent) => void;
declare const _onCopy: (this: Squire, event: ClipboardEvent) => void;
declare const _monitorShiftKey: (this: Squire, event: KeyboardEvent) => void;
declare const _onPaste: (this: Squire, event: ClipboardEvent) => void;
declare const _onDrop: (this: Squire, event: DragEvent) => void;
export { extractRangeToClipboard, _onCut, _onCopy, _monitorShiftKey, _onPaste, _onDrop, };
//# sourceMappingURL=Clipboard.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Clipboard.d.ts","sourceRoot":"","sources":["../../source/Clipboard.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAOvC,QAAA,MAAM,uBAAuB,UAClB,cAAc,SACd,KAAK,QACN,WAAW,2BACQ,OAAO,eACnB,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,eACjC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,iBAC/B,OAAO,KACvB,OA0FF,CAAC;AAIF,QAAA,MAAM,MAAM,SAAmB,MAAM,SAAS,cAAc,KAAG,IAkC9D,CAAC;AAEF,QAAA,MAAM,OAAO,SAAmB,MAAM,SAAS,cAAc,KAAG,IAU/D,CAAC;AAIF,QAAA,MAAM,gBAAgB,SAAmB,MAAM,SAAS,aAAa,KAAG,IAEvE,CAAC;AAEF,QAAA,MAAM,QAAQ,SAAmB,MAAM,SAAS,cAAc,KAAG,IAqLhE,CAAC;AAKF,QAAA,MAAM,OAAO,SAAmB,MAAM,SAAS,SAAS,KAAG,IAwB1D,CAAC;AAIF,OAAO,EACH,uBAAuB,EACvB,MAAM,EACN,OAAO,EACP,gBAAgB,EAChB,QAAQ,EACR,OAAO,GACV,CAAC"}

View file

@ -0,0 +1,20 @@
declare const DOCUMENT_POSITION_PRECEDING = 2;
declare const ELEMENT_NODE = 1;
declare const TEXT_NODE = 3;
declare const DOCUMENT_NODE = 9;
declare const DOCUMENT_FRAGMENT_NODE = 11;
declare const ZWS = "\u200B";
declare const ua: string;
declare const isMac: boolean;
declare const isWin: boolean;
declare const isIOS: boolean;
declare const isAndroid: boolean;
declare const isGecko: boolean;
declare const isLegacyEdge: boolean;
declare const isWebKit: boolean;
declare const ctrlKey: string;
declare const cantFocusEmptyTextNodes: boolean;
declare const supportsInputEvents: boolean;
declare const notWS: RegExp;
export { DOCUMENT_POSITION_PRECEDING, ELEMENT_NODE, TEXT_NODE, DOCUMENT_NODE, DOCUMENT_FRAGMENT_NODE, notWS, ZWS, ua, isMac, isWin, isIOS, isAndroid, isGecko, isLegacyEdge, isWebKit, ctrlKey, cantFocusEmptyTextNodes, supportsInputEvents, };
//# sourceMappingURL=Constants.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Constants.d.ts","sourceRoot":"","sources":["../../source/Constants.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,2BAA2B,IAAI,CAAC;AACtC,QAAA,MAAM,YAAY,IAAI,CAAC;AACvB,QAAA,MAAM,SAAS,IAAI,CAAC;AACpB,QAAA,MAAM,aAAa,IAAI,CAAC;AACxB,QAAA,MAAM,sBAAsB,KAAK,CAAC;AAElC,QAAA,MAAM,GAAG,WAAW,CAAC;AAErB,QAAA,MAAM,EAAE,QAAsB,CAAC;AAE/B,QAAA,MAAM,KAAK,SAAsB,CAAC;AAClC,QAAA,MAAM,KAAK,SAAwB,CAAC;AACpC,QAAA,MAAM,KAAK,SAC6D,CAAC;AACzE,QAAA,MAAM,SAAS,SAAqB,CAAC;AAErC,QAAA,MAAM,OAAO,SAAqB,CAAC;AACnC,QAAA,MAAM,YAAY,SAAoB,CAAC;AACvC,QAAA,MAAM,QAAQ,SAAuC,CAAC;AAEtD,QAAA,MAAM,OAAO,QAAqC,CAAC;AAEnD,QAAA,MAAM,uBAAuB,SAAW,CAAC;AAEzC,QAAA,MAAM,mBAAmB,SACgD,CAAC;AAG1E,QAAA,MAAM,KAAK,QAAe,CAAC;AAI3B,OAAO,EACH,2BAA2B,EAC3B,YAAY,EACZ,SAAS,EACT,aAAa,EACb,sBAAsB,EACtB,KAAK,EACL,GAAG,EACH,EAAE,EACF,KAAK,EACL,KAAK,EACL,KAAK,EACL,SAAS,EACT,OAAO,EACP,YAAY,EACZ,QAAQ,EACR,OAAO,EACP,uBAAuB,EACvB,mBAAmB,GACtB,CAAC"}

View file

@ -0,0 +1,174 @@
type EventHandler = {
handleEvent: (e: Event) => void;
} | ((e: Event) => void);
type KeyHandlerFunction = (x: Squire, y: KeyboardEvent, z: Range) => void;
type TagAttributes = {
[key: string]: {
[key: string]: string;
};
};
interface SquireConfig {
blockTag: string;
blockAttributes: null | Record<string, string>;
tagAttributes: TagAttributes;
classNames: {
color: string;
fontFamily: string;
fontSize: string;
highlight: string;
};
undo: {
documentSizeThreshold: number;
undoLimit: number;
};
addLinks: boolean;
willCutCopy: null | ((html: string) => string);
toPlainText: null | ((html: string) => string);
sanitizeToDOMFragment: (html: string, editor: Squire) => DocumentFragment;
didError: (x: any) => void;
}
declare class Squire {
_root: HTMLElement;
_config: SquireConfig;
_isFocused: boolean;
_lastSelection: Range;
_willRestoreSelection: boolean;
_mayHaveZWS: boolean;
_lastAnchorNode: Node | null;
_lastFocusNode: Node | null;
_path: string;
_events: Map<string, Array<EventHandler>>;
_undoIndex: number;
_undoStack: Array<string>;
_undoStackLength: number;
_isInUndoState: boolean;
_ignoreChange: boolean;
_ignoreAllChanges: boolean;
_isShiftDown: boolean;
_keyHandlers: Record<string, KeyHandlerFunction>;
_mutation: MutationObserver;
constructor(root: HTMLElement, config?: Partial<SquireConfig>);
destroy(): void;
_makeConfig(userConfig?: object): SquireConfig;
setKeyHandler(key: string, fn: KeyHandlerFunction): this;
_beforeInput(event: InputEvent): void;
handleEvent(event: Event): void;
fireEvent(type: string, detail?: Event | object): Squire;
/**
* Subscribing to these events won't automatically add a listener to the
* document node, since these events are fired in a custom manner by the
* editor code.
*/
customEvents: Set<string>;
addEventListener(type: string, fn: EventHandler): Squire;
removeEventListener(type: string, fn?: EventHandler): Squire;
focus(): Squire;
blur(): Squire;
_enableRestoreSelection(): void;
_disableRestoreSelection(): void;
_restoreSelection(): void;
_removeZWS(): void;
startSelectionId: string;
endSelectionId: string;
_saveRangeToBookmark(range: Range): void;
_getRangeAndRemoveBookmark(range?: Range): Range | null;
getSelection(): Range;
setSelection(range: Range): Squire;
_moveCursorTo(toStart: boolean): Squire;
moveCursorToStart(): Squire;
moveCursorToEnd(): Squire;
getCursorPosition(): DOMRect;
getPath(): string;
_updatePathOnEvent(): void;
_updatePath(range: Range, force?: boolean): void;
_getPath(node: Node): string;
modifyDocument(modificationFn: () => void): Squire;
_docWasChanged(): void;
/**
* Leaves bookmark.
*/
_recordUndoState(range: Range, replace?: boolean): Squire;
saveUndoState(range?: Range): Squire;
undo(): Squire;
redo(): Squire;
getRoot(): HTMLElement;
_getRawHTML(): string;
_setRawHTML(html: string): Squire;
getHTML(withBookmark?: boolean): string;
setHTML(html: string): Squire;
/**
* Insert HTML at the cursor location. If the selection is not collapsed
* insertTreeFragmentIntoRange will delete the selection so that it is
* replaced by the html being inserted.
*/
insertHTML(html: string, isPaste?: boolean): Squire;
insertElement(el: Element, range?: Range): Squire;
insertImage(src: string, attributes: Record<string, string>): HTMLImageElement;
insertPlainText(plainText: string, isPaste: boolean): Squire;
getSelectedText(range?: Range): string;
/**
* Extracts the font-family and font-size (if any) of the element
* holding the cursor. If there's a selection, returns an empty object.
*/
getFontInfo(range?: Range): Record<string, string | undefined>;
/**
* Looks for matching tag and attributes, so won't work if <strong>
* instead of <b> etc.
*/
hasFormat(tag: string, attributes?: Record<string, string> | null, range?: Range): boolean;
changeFormat(add: {
tag: string;
attributes?: Record<string, string>;
} | null, remove?: {
tag: string;
attributes?: Record<string, string>;
} | null, range?: Range, partial?: boolean): Squire;
_addFormat(tag: string, attributes: Record<string, string> | null, range: Range): Range;
_removeFormat(tag: string, attributes: Record<string, string>, range: Range, partial?: boolean): Range;
bold(): Squire;
removeBold(): Squire;
italic(): Squire;
removeItalic(): Squire;
underline(): Squire;
removeUnderline(): Squire;
strikethrough(): Squire;
removeStrikethrough(): Squire;
subscript(): Squire;
removeSubscript(): Squire;
superscript(): Squire;
removeSuperscript(): Squire;
makeLink(url: string, attributes?: Record<string, string>): Squire;
removeLink(): Squire;
linkRegExp: RegExp;
addDetectedLinks(searchInNode: DocumentFragment | Node, root?: DocumentFragment | HTMLElement): Squire;
setFontFace(name: string | null): Squire;
setFontSize(size: string | null): Squire;
setTextColor(color: string | null): Squire;
setHighlightColor(color: string | null): Squire;
_ensureBottomLine(): void;
createDefaultBlock(children?: Node[]): HTMLElement;
tagAfterSplit: Record<string, string>;
splitBlock(lineBreakOnly: boolean, range?: Range): Squire;
forEachBlock(fn: (el: HTMLElement) => any, mutates: boolean, range?: Range): Squire;
modifyBlocks(modify: (x: DocumentFragment) => Node, range?: Range): Squire;
setTextAlignment(alignment: string): Squire;
setTextDirection(direction: string | null): Squire;
_getListSelection(range: Range, root: Element): [Node, Node | null, Node | null] | null;
increaseListLevel(range?: Range): Squire;
decreaseListLevel(range?: Range): Squire;
_makeList(frag: DocumentFragment, type: string): DocumentFragment;
makeUnorderedList(): Squire;
makeOrderedList(): Squire;
removeList(): Squire;
increaseQuoteLevel(range?: Range): Squire;
decreaseQuoteLevel(range?: Range): Squire;
removeQuote(range?: Range): Squire;
code(): Squire;
removeCode(): Squire;
toggleCode(): Squire;
_removeFormatting(root: DocumentFragment | Element, clean: DocumentFragment | Element): DocumentFragment | Element;
removeAllFormatting(range?: Range): Squire;
}
export { Squire };
export type { SquireConfig };
//# sourceMappingURL=Editor.d.ts.map

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,2 @@
export {};
//# sourceMappingURL=Legacy.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Legacy.d.ts","sourceRoot":"","sources":["../../source/Legacy.ts"],"names":[],"mappings":""}

View file

@ -0,0 +1,3 @@
import { Squire } from './Editor';
export default Squire;
//# sourceMappingURL=Squire.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Squire.d.ts","sourceRoot":"","sources":["../../source/Squire.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,eAAe,MAAM,CAAC"}

View file

@ -0,0 +1,4 @@
import type { Squire } from '../Editor';
declare const Backspace: (self: Squire, event: KeyboardEvent, range: Range) => void;
export { Backspace };
//# sourceMappingURL=Backspace.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Backspace.d.ts","sourceRoot":"","sources":["../../../source/keyboard/Backspace.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAkBxC,QAAA,MAAM,SAAS,SAAU,MAAM,SAAS,aAAa,SAAS,KAAK,KAAG,IAwFrE,CAAC;AAIF,OAAO,EAAE,SAAS,EAAE,CAAC"}

View file

@ -0,0 +1,4 @@
import type { Squire } from '../Editor';
declare const Delete: (self: Squire, event: KeyboardEvent, range: Range) => void;
export { Delete };
//# sourceMappingURL=Delete.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Delete.d.ts","sourceRoot":"","sources":["../../../source/keyboard/Delete.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAIxC,QAAA,MAAM,MAAM,SAAU,MAAM,SAAS,aAAa,SAAS,KAAK,KAAG,IAyElE,CAAC;AAIF,OAAO,EAAE,MAAM,EAAE,CAAC"}

View file

@ -0,0 +1,4 @@
import type { Squire } from '../Editor';
declare const Enter: (self: Squire, event: KeyboardEvent, range: Range) => void;
export { Enter };
//# sourceMappingURL=Enter.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Enter.d.ts","sourceRoot":"","sources":["../../../source/keyboard/Enter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAIxC,QAAA,MAAM,KAAK,SAAU,MAAM,SAAS,aAAa,SAAS,KAAK,KAAG,IAGjE,CAAC;AAIF,OAAO,EAAE,KAAK,EAAE,CAAC"}

View file

@ -0,0 +1,6 @@
import type { Squire } from '../Editor';
declare const _onKey: (this: Squire, event: KeyboardEvent) => void;
type KeyHandler = (self: Squire, event: KeyboardEvent, range: Range) => void;
declare const keyHandlers: Record<string, KeyHandler>;
export { _onKey, keyHandlers };
//# sourceMappingURL=KeyHandlers.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"KeyHandlers.d.ts","sourceRoot":"","sources":["../../../source/keyboard/KeyHandlers.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAWxC,QAAA,MAAM,MAAM,SAAmB,MAAM,SAAS,aAAa,KAAG,IAuD7D,CAAC;AAIF,KAAK,UAAU,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;AAE7E,QAAA,MAAM,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAoC3C,CAAC;AA4GF,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC"}

View file

@ -0,0 +1,6 @@
import type { Squire } from '../Editor';
declare const afterDelete: (self: Squire, range?: Range) => void;
declare const detachUneditableNode: (node: Node, root: Element) => void;
declare const linkifyText: (self: Squire, textNode: Text, offset: number) => void;
export { afterDelete, detachUneditableNode, linkifyText };
//# sourceMappingURL=KeyHelpers.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"KeyHelpers.d.ts","sourceRoot":"","sources":["../../../source/keyboard/KeyHelpers.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAQxC,QAAA,MAAM,WAAW,SAAU,MAAM,UAAU,KAAK,KAAG,IAsDlD,CAAC;AAEF,QAAA,MAAM,oBAAoB,SAAU,IAAI,QAAQ,OAAO,KAAG,IASzD,CAAC;AAIF,QAAA,MAAM,WAAW,SAAU,MAAM,YAAY,IAAI,UAAU,MAAM,KAAG,IAmDnE,CAAC;AAIF,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,WAAW,EAAE,CAAC"}

View file

@ -0,0 +1,4 @@
import type { Squire } from '../Editor';
declare const Space: (self: Squire, event: KeyboardEvent, range: Range) => void;
export { Space };
//# sourceMappingURL=Space.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Space.d.ts","sourceRoot":"","sources":["../../../source/keyboard/Space.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAWxC,QAAA,MAAM,KAAK,SAAU,MAAM,SAAS,aAAa,SAAS,KAAK,KAAG,IAiEjE,CAAC;AAIF,OAAO,EAAE,KAAK,EAAE,CAAC"}

View file

@ -0,0 +1,5 @@
import type { Squire } from '../Editor';
declare const Tab: (self: Squire, event: KeyboardEvent, range: Range) => void;
declare const ShiftTab: (self: Squire, event: KeyboardEvent, range: Range) => void;
export { Tab, ShiftTab };
//# sourceMappingURL=Tab.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Tab.d.ts","sourceRoot":"","sources":["../../../source/keyboard/Tab.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAIxC,QAAA,MAAM,GAAG,SAAU,MAAM,SAAS,aAAa,SAAS,KAAK,KAAG,IAmB/D,CAAC;AAEF,QAAA,MAAM,QAAQ,SAAU,MAAM,SAAS,aAAa,SAAS,KAAK,KAAG,IAYpE,CAAC;AAIF,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC"}

View file

@ -0,0 +1,7 @@
import { TreeIterator } from './TreeIterator';
declare const getBlockWalker: (node: Node, root: Element | DocumentFragment) => TreeIterator<HTMLElement>;
declare const getPreviousBlock: (node: Node, root: Element | DocumentFragment) => HTMLElement | null;
declare const getNextBlock: (node: Node, root: Element | DocumentFragment) => HTMLElement | null;
declare const isEmptyBlock: (block: Element) => boolean;
export { getBlockWalker, getPreviousBlock, getNextBlock, isEmptyBlock };
//# sourceMappingURL=Block.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Block.d.ts","sourceRoot":"","sources":["../../../source/node/Block.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAgB,MAAM,gBAAgB,CAAC;AAK5D,QAAA,MAAM,cAAc,SACV,IAAI,QACJ,OAAO,GAAG,gBAAgB,KACjC,YAAY,CAAC,WAAW,CAI1B,CAAC;AAEF,QAAA,MAAM,gBAAgB,SACZ,IAAI,QACJ,OAAO,GAAG,gBAAgB,KACjC,WAAW,GAAG,IAGhB,CAAC;AAEF,QAAA,MAAM,YAAY,SACR,IAAI,QACJ,OAAO,GAAG,gBAAgB,KACjC,WAAW,GAAG,IAGhB,CAAC;AAEF,QAAA,MAAM,YAAY,UAAW,OAAO,KAAG,OAEtC,CAAC;AAIF,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC"}

View file

@ -0,0 +1,9 @@
declare const leafNodeNames: Set<string>;
declare const resetNodeCategoryCache: () => void;
declare const isLeaf: (node: Node) => boolean;
declare const getNodeCategory: (node: Node) => number;
declare const isInline: (node: Node) => boolean;
declare const isBlock: (node: Node) => boolean;
declare const isContainer: (node: Node) => boolean;
export { getNodeCategory, isBlock, isContainer, isInline, isLeaf, leafNodeNames, resetNodeCategoryCache, };
//# sourceMappingURL=Category.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Category.d.ts","sourceRoot":"","sources":["../../../source/node/Category.ts"],"names":[],"mappings":"AAOA,QAAA,MAAM,aAAa,aAAkD,CAAC;AAWtE,QAAA,MAAM,sBAAsB,QAAO,IAElC,CAAC;AAIF,QAAA,MAAM,MAAM,SAAU,IAAI,KAAG,OAE5B,CAAC;AAEF,QAAA,MAAM,eAAe,SAAU,IAAI,KAAG,MA0BrC,CAAC;AAEF,QAAA,MAAM,QAAQ,SAAU,IAAI,KAAG,OAE9B,CAAC;AAEF,QAAA,MAAM,OAAO,SAAU,IAAI,KAAG,OAE7B,CAAC;AAEF,QAAA,MAAM,WAAW,SAAU,IAAI,KAAG,OAEjC,CAAC;AAIF,OAAO,EACH,eAAe,EACf,OAAO,EACP,WAAW,EACX,QAAQ,EACR,MAAM,EACN,aAAa,EACb,sBAAsB,GACzB,CAAC"}

View file

@ -0,0 +1,8 @@
declare const fixCursor: (node: Node) => Node;
declare const fixContainer: (container: Node, root: Element | DocumentFragment) => Node;
declare const split: (node: Node, offset: number | Node | null, stopNode: Node, root: Element | DocumentFragment) => Node | null;
declare const mergeInlines: (node: Node, range: Range) => void;
declare const mergeWithBlock: (block: Node, next: Node, range: Range, root: Element) => void;
declare const mergeContainers: (node: Node, root: Element) => void;
export { fixContainer, fixCursor, mergeContainers, mergeInlines, mergeWithBlock, split, };
//# sourceMappingURL=MergeSplit.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"MergeSplit.d.ts","sourceRoot":"","sources":["../../../source/node/MergeSplit.ts"],"names":[],"mappings":"AAaA,QAAA,MAAM,SAAS,SAAU,IAAI,KAAG,IA6C/B,CAAC;AAGF,QAAA,MAAM,YAAY,cACH,IAAI,QACT,OAAO,GAAG,gBAAgB,KACjC,IA6BF,CAAC;AAEF,QAAA,MAAM,KAAK,SACD,IAAI,UACF,MAAM,GAAG,IAAI,GAAG,IAAI,YAClB,IAAI,QACR,OAAO,GAAG,gBAAgB,KACjC,IAAI,GAAG,IAoDT,CAAC;AA0DF,QAAA,MAAM,YAAY,SAAU,IAAI,SAAS,KAAK,KAAG,IAahD,CAAC;AAEF,QAAA,MAAM,cAAc,UACT,IAAI,QACL,IAAI,SACH,KAAK,QACN,OAAO,KACd,IA4BF,CAAC;AAEF,QAAA,MAAM,eAAe,SAAU,IAAI,QAAQ,OAAO,KAAG,IAkCpD,CAAC;AAIF,OAAO,EACH,YAAY,EACZ,SAAS,EACT,eAAe,EACf,YAAY,EACZ,cAAc,EACd,KAAK,GACR,CAAC"}

View file

@ -0,0 +1,12 @@
declare const createElement: (tag: string, props?: Record<string, string> | null, children?: Node[]) => HTMLElement;
declare const areAlike: (node: HTMLElement | Node, node2: HTMLElement | Node) => boolean;
declare const hasTagAttributes: (node: Node | Element, tag: string, attributes?: Record<string, string> | null) => boolean;
declare const getNearest: (node: Node | null, root: Element | DocumentFragment, tag: string, attributes?: Record<string, string> | null) => Node | null;
declare const getNodeBeforeOffset: (node: Node, offset: number) => Node;
declare const getNodeAfterOffset: (node: Node, offset: number) => Node | null;
declare const getLength: (node: Node) => number;
declare const empty: (node: Node) => DocumentFragment;
declare const detach: (node: Node) => Node;
declare const replaceWith: (node: Node, node2: Node) => void;
export { areAlike, createElement, detach, empty, getLength, getNearest, getNodeAfterOffset, getNodeBeforeOffset, hasTagAttributes, replaceWith, };
//# sourceMappingURL=Node.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Node.d.ts","sourceRoot":"","sources":["../../../source/node/Node.ts"],"names":[],"mappings":"AAIA,QAAA,MAAM,aAAa,QACV,MAAM,UACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,aAC1B,IAAI,EAAE,KAClB,WAkBF,CAAC;AAIF,QAAA,MAAM,QAAQ,SACJ,WAAW,GAAG,IAAI,SACjB,WAAW,GAAG,IAAI,KAC1B,OAeF,CAAC;AAEF,QAAA,MAAM,gBAAgB,SACZ,IAAI,GAAG,OAAO,OACf,MAAM,eACE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,KAC3C,OAaF,CAAC;AAIF,QAAA,MAAM,UAAU,SACN,IAAI,GAAG,IAAI,QACX,OAAO,GAAG,gBAAgB,OAC3B,MAAM,eACE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,KAC3C,IAAI,GAAG,IAQT,CAAC;AAEF,QAAA,MAAM,mBAAmB,SAAU,IAAI,UAAU,MAAM,KAAG,IAQzD,CAAC;AAEF,QAAA,MAAM,kBAAkB,SAAU,IAAI,UAAU,MAAM,KAAG,IAAI,GAAG,IAgB/D,CAAC;AAEF,QAAA,MAAM,SAAS,SAAU,IAAI,KAAG,MAM/B,CAAC;AAIF,QAAA,MAAM,KAAK,SAAU,IAAI,KAAG,gBAQ3B,CAAC;AAEF,QAAA,MAAM,MAAM,SAAU,IAAI,KAAG,IAM5B,CAAC;AAEF,QAAA,MAAM,WAAW,SAAU,IAAI,SAAS,IAAI,KAAG,IAK9C,CAAC;AAIF,OAAO,EACH,QAAQ,EACR,aAAa,EACb,MAAM,EACN,KAAK,EACL,SAAS,EACT,UAAU,EACV,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,WAAW,GACd,CAAC"}

View file

@ -0,0 +1,17 @@
type NODE_TYPE = 1 | 4 | 5;
declare const SHOW_ELEMENT = 1;
declare const SHOW_TEXT = 4;
declare const SHOW_ELEMENT_OR_TEXT = 5;
declare class TreeIterator<T extends Node> {
root: Node;
currentNode: Node;
nodeType: NODE_TYPE;
filter: (n: T) => boolean;
constructor(root: Node, nodeType: NODE_TYPE, filter?: (n: T) => boolean);
isAcceptableNode(node: Node): boolean;
nextNode(): T | null;
previousNode(): T | null;
previousPONode(): T | null;
}
export { TreeIterator, SHOW_ELEMENT, SHOW_TEXT, SHOW_ELEMENT_OR_TEXT };
//# sourceMappingURL=TreeIterator.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"TreeIterator.d.ts","sourceRoot":"","sources":["../../../source/node/TreeIterator.ts"],"names":[],"mappings":"AAAA,KAAK,SAAS,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC3B,QAAA,MAAM,YAAY,IAAI,CAAC;AACvB,QAAA,MAAM,SAAS,IAAI,CAAC;AACpB,QAAA,MAAM,oBAAoB,IAAI,CAAC;AAI/B,cAAM,YAAY,CAAC,CAAC,SAAS,IAAI;IAC7B,IAAI,EAAE,IAAI,CAAC;IACX,WAAW,EAAE,IAAI,CAAC;IAClB,QAAQ,EAAE,SAAS,CAAC;IACpB,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC;gBAEd,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO;IAOvE,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO;IAWrC,QAAQ,IAAI,CAAC,GAAG,IAAI;IA2BpB,YAAY,IAAI,CAAC,GAAG,IAAI;IA4BxB,cAAc,IAAI,CAAC,GAAG,IAAI;CAyB7B;AAID,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAC"}

View file

@ -0,0 +1,4 @@
declare const isLineBreak: (br: Element, isLBIfEmptyBlock: boolean) => boolean;
declare const removeZWS: (root: Node, keepNode?: Node | null) => void;
export { isLineBreak, removeZWS };
//# sourceMappingURL=Whitespace.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Whitespace.d.ts","sourceRoot":"","sources":["../../../source/node/Whitespace.ts"],"names":[],"mappings":"AAcA,QAAA,MAAM,WAAW,OAAQ,OAAO,oBAAoB,OAAO,KAAG,OAY7D,CAAC;AAUF,QAAA,MAAM,SAAS,SAAU,IAAI,aAAa,IAAI,GAAG,IAAI,KAAG,IA4BvD,CAAC;AAIF,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC"}

View file

@ -0,0 +1,7 @@
declare const getStartBlockOfRange: (range: Range, root: Element | DocumentFragment) => HTMLElement | null;
declare const getEndBlockOfRange: (range: Range, root: Element | DocumentFragment) => HTMLElement | null;
declare const rangeDoesStartAtBlockBoundary: (range: Range, root: Element) => boolean;
declare const rangeDoesEndAtBlockBoundary: (range: Range, root: Element) => boolean;
declare const expandRangeToBlockBoundaries: (range: Range, root: Element) => void;
export { getStartBlockOfRange, getEndBlockOfRange, rangeDoesStartAtBlockBoundary, rangeDoesEndAtBlockBoundary, expandRangeToBlockBoundaries, };
//# sourceMappingURL=Block.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Block.d.ts","sourceRoot":"","sources":["../../../source/range/Block.ts"],"names":[],"mappings":"AAWA,QAAA,MAAM,oBAAoB,UACf,KAAK,QACN,OAAO,GAAG,gBAAgB,KACjC,WAAW,GAAG,IAmBhB,CAAC;AAIF,QAAA,MAAM,kBAAkB,UACb,KAAK,QACN,OAAO,GAAG,gBAAgB,KACjC,WAAW,GAAG,IA0BhB,CAAC;AAQF,QAAA,MAAM,6BAA6B,UACxB,KAAK,QACN,OAAO,KACd,OAyCF,CAAC;AAEF,QAAA,MAAM,2BAA2B,UAAW,KAAK,QAAQ,OAAO,KAAG,OAgClE,CAAC;AAEF,QAAA,MAAM,4BAA4B,UAAW,KAAK,QAAQ,OAAO,KAAG,IAWnE,CAAC;AAIF,OAAO,EACH,oBAAoB,EACpB,kBAAkB,EAClB,6BAA6B,EAC7B,2BAA2B,EAC3B,4BAA4B,GAC/B,CAAC"}

View file

@ -0,0 +1,10 @@
declare const isNodeContainedInRange: (range: Range, node: Node, partial: boolean) => boolean;
/**
* Moves the range to an equivalent position with the start/end as deep in
* the tree as possible.
*/
declare const moveRangeBoundariesDownTree: (range: Range) => void;
declare const moveRangeBoundariesUpTree: (range: Range, startMax: Node, endMax: Node, root: Node) => void;
declare const moveRangeBoundaryOutOf: (range: Range, tag: string, root: Element) => Range;
export { isNodeContainedInRange, moveRangeBoundariesDownTree, moveRangeBoundariesUpTree, moveRangeBoundaryOutOf, };
//# sourceMappingURL=Boundaries.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Boundaries.d.ts","sourceRoot":"","sources":["../../../source/range/Boundaries.ts"],"names":[],"mappings":"AAYA,QAAA,MAAM,sBAAsB,UACjB,KAAK,QACN,IAAI,WACD,OAAO,KACjB,OAoBF,CAAC;AAEF;;;GAGG;AACH,QAAA,MAAM,2BAA2B,UAAW,KAAK,KAAG,IA6DnD,CAAC;AAEF,QAAA,MAAM,yBAAyB,UACpB,KAAK,YACF,IAAI,UACN,IAAI,QACN,IAAI,KACX,IAkDF,CAAC;AAEF,QAAA,MAAM,sBAAsB,UACjB,KAAK,OACP,MAAM,QACL,OAAO,KACd,KAWF,CAAC;AAIF,OAAO,EACH,sBAAsB,EACtB,2BAA2B,EAC3B,yBAAyB,EACzB,sBAAsB,GACzB,CAAC"}

View file

@ -0,0 +1,3 @@
declare const getTextContentsOfRange: (range: Range) => string;
export { getTextContentsOfRange };
//# sourceMappingURL=Contents.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"Contents.d.ts","sourceRoot":"","sources":["../../../source/range/Contents.ts"],"names":[],"mappings":"AAMA,QAAA,MAAM,sBAAsB,UAAW,KAAK,WAsD3C,CAAC;AAIF,OAAO,EAAE,sBAAsB,EAAE,CAAC"}

View file

@ -0,0 +1,14 @@
declare function createRange(startContainer: Node, startOffset: number): Range;
declare function createRange(startContainer: Node, startOffset: number, endContainer: Node, endOffset: number): Range;
declare const insertNodeInRange: (range: Range, node: Node) => void;
/**
* Removes the contents of the range and returns it as a DocumentFragment.
* The range at the end will be at the same position, with the edges just
* before/after the split. If the start/end have the same parents, it will
* be collapsed.
*/
declare const extractContentsOfRange: (range: Range, common: Node | null, root: Element) => DocumentFragment;
declare const deleteContentsOfRange: (range: Range, root: Element) => DocumentFragment;
declare const insertTreeFragmentIntoRange: (range: Range, frag: DocumentFragment, root: Element) => void;
export { createRange, deleteContentsOfRange, extractContentsOfRange, insertNodeInRange, insertTreeFragmentIntoRange, };
//# sourceMappingURL=InsertDelete.d.ts.map

View file

@ -0,0 +1 @@
{"version":3,"file":"InsertDelete.d.ts","sourceRoot":"","sources":["../../../source/range/InsertDelete.ts"],"names":[],"mappings":"AAyBA,iBAAS,WAAW,CAAC,cAAc,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,GAAG,KAAK,CAAC;AACvE,iBAAS,WAAW,CAChB,cAAc,EAAE,IAAI,EACpB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,IAAI,EAClB,SAAS,EAAE,MAAM,GAClB,KAAK,CAAC;AAiBT,QAAA,MAAM,iBAAiB,UAAW,KAAK,QAAQ,IAAI,KAAG,IAiDrD,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,sBAAsB,UACjB,KAAK,UACJ,IAAI,GAAG,IAAI,QACb,OAAO,KACd,gBA8CF,CAAC;AAuBF,QAAA,MAAM,qBAAqB,UAChB,KAAK,QACN,OAAO,KACd,gBA8GF,CAAC;AAIF,QAAA,MAAM,2BAA2B,UACtB,KAAK,QACN,gBAAgB,QAChB,OAAO,KACd,IAsIF,CAAC;AAIF,OAAO,EACH,WAAW,EACX,qBAAqB,EACrB,sBAAsB,EACtB,iBAAiB,EACjB,2BAA2B,GAC9B,CAAC"}

48
vendors/squire-rte/package.json vendored Normal file
View file

@ -0,0 +1,48 @@
{
"name": "squire-rte",
"version": "2.3.1",
"description": "Squire is an HTML5 rich text editor, which provides powerful cross-browser normalisation, whilst being supremely lightweight and flexible.",
"main": "dist/squire.mjs",
"types": "dist/types/Squire.d.ts",
"type": "module",
"scripts": {
"test": "jest",
"build": "./build.js && tsc",
"lint": "eslint source",
"fix": "eslint --fix source && prettier --write source"
},
"repository": {
"type": "git",
"url": "https://github.com/neilj/Squire.git"
},
"keywords": [
"wysiwyg",
"editor",
"text",
"html",
"squire"
],
"author": "Neil Jenkins",
"license": "MIT",
"bugs": {
"url": "https://github.com/neilj/Squire/issues"
},
"homepage": "https://github.com/neilj/Squire",
"devDependencies": {
"@babel/core": "^7.24.9",
"@babel/preset-env": "^7.24.8",
"@babel/preset-typescript": "^7.24.7",
"@types/jest": "^29.5.12",
"@typescript-eslint/eslint-plugin": "^7.16.1",
"babel-jest": "^29.7.0",
"esbuild": "^0.23.0",
"eslint": "^8.57.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-prettier": "^5.1.3",
"jest": "^29.7.0",
"jest-environment-jsdom": "^29.7.0",
"prettier": "^3.3.3",
"tslib": "^2.6.3",
"typescript": "^5.5.3"
}
}