npm - brut-js - Versions diffs - 0.16.0-pre → 0.17.0 - Mend

brut-js 0.16.0-pre → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2296) hide show

package/docs/node_modules/xmlcreate/lib/nodes/XmlDocument.d.ts ADDED Viewed

@@ -0,0 +1,96 @@
+/**
+ * Copyright (C) 2016-2019 Michael Kourlas
+ *
+ * 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.
+ */
+import { IStringOptions } from "../options";
+import XmlComment, { IXmlCommentOptions } from "./XmlComment";
+import XmlDecl, { IXmlDeclOptions } from "./XmlDecl";
+import XmlDtd, { IXmlDtdOptions } from "./XmlDtd";
+import XmlElement, { IXmlElementOptions } from "./XmlElement";
+import XmlProcInst, { IXmlProcInstOptions } from "./XmlProcInst";
+/**
+ * The options used to create a new document.
+ */
+export interface IXmlDocumentOptions {
+    /**
+     * Whether to throw an exception if basic XML validation fails while
+     * building the document.
+     */
+    validation?: boolean;
+}
+/**
+ * Represents a document.
+ *
+ * A sample document is structured as follows:
+ *
+ * ```xml
+ * <?xml version="1.0" encoding="UTF-8"?>
+ * <DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ *                      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+ * <html>
+ *     <head>
+ *         <title>My page title</title>
+ *     </head>
+ *     <body>
+ *         <h1>Welcome!</h1>
+ *         <p>I hope you enjoy visiting my website.</p>
+ *         <img src="picture.png"/>
+ *     </body>
+ * </html>
+ * ```
+ *
+ * Each component of the document, such as the declaration, document type
+ * definition, and root element, are children of this node.
+ *
+ * Documents must have exactly one element, which is the document's root
+ * element.
+ *
+ * Documents can have exactly one declaration and one document type definition
+ * in that order, so long as they precede the element.
+ *
+ * Documents can have an unlimited number of comments or processing
+ * instructions, so long as they follow the declaration, if one exists.
+ */
+export default class XmlDocument {
+    private readonly _children;
+    private readonly _validation;
+    constructor(options: IXmlDocumentOptions);
+    /**
+     * Adds a comment to this document and returns the new comment.
+     */
+    comment(options: IXmlCommentOptions): XmlComment<this>;
+    /**
+     * Adds a declaration to this document and returns the new declaration.
+     */
+    decl(options?: IXmlDeclOptions): XmlDecl<this>;
+    /**
+     * Adds a document type definition to this document and returns the new
+     * document type definition.
+     */
+    dtd(options: IXmlDtdOptions): XmlDtd<this>;
+    /**
+     * Adds the root element to this document and returns the element.
+     */
+    element(options: IXmlElementOptions): XmlElement<this>;
+    /**
+     * Adds a processing instruction to this document and returns the new
+     * processing instruction.
+     */
+    procInst(options: IXmlProcInstOptions): XmlProcInst<this>;
+    /**
+     * Returns an XML string representation of this document using the
+     * specified options.
+     */
+    toString(options?: IStringOptions): string;
+}

package/docs/node_modules/xmlcreate/lib/nodes/XmlDocument.js ADDED Viewed

@@ -0,0 +1,166 @@
+"use strict";
+/**
+ * Copyright (C) 2016-2019 Michael Kourlas
+ *
+ * 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.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var options_1 = require("../options");
+var validate_1 = require("../validate");
+var XmlComment_1 = __importDefault(require("./XmlComment"));
+var XmlDecl_1 = __importDefault(require("./XmlDecl"));
+var XmlDtd_1 = __importDefault(require("./XmlDtd"));
+var XmlElement_1 = __importDefault(require("./XmlElement"));
+var XmlProcInst_1 = __importDefault(require("./XmlProcInst"));
+/**
+ * Represents a document.
+ *
+ * A sample document is structured as follows:
+ *
+ * ```xml
+ * <?xml version="1.0" encoding="UTF-8"?>
+ * <DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ *                      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+ * <html>
+ *     <head>
+ *         <title>My page title</title>
+ *     </head>
+ *     <body>
+ *         <h1>Welcome!</h1>
+ *         <p>I hope you enjoy visiting my website.</p>
+ *         <img src="picture.png"/>
+ *     </body>
+ * </html>
+ * ```
+ *
+ * Each component of the document, such as the declaration, document type
+ * definition, and root element, are children of this node.
+ *
+ * Documents must have exactly one element, which is the document's root
+ * element.
+ *
+ * Documents can have exactly one declaration and one document type definition
+ * in that order, so long as they precede the element.
+ *
+ * Documents can have an unlimited number of comments or processing
+ * instructions, so long as they follow the declaration, if one exists.
+ */
+var XmlDocument = /** @class */ (function () {
+    function XmlDocument(options) {
+        this._children = [];
+        this._validation = !(0, validate_1.isUndefined)(options.validation)
+            ? options.validation
+            : true;
+    }
+    /**
+     * Adds a comment to this document and returns the new comment.
+     */
+    XmlDocument.prototype.comment = function (options) {
+        var comment = new XmlComment_1.default(this, this._validation, options);
+        this._children.push(comment);
+        return comment;
+    };
+    /**
+     * Adds a declaration to this document and returns the new declaration.
+     */
+    XmlDocument.prototype.decl = function (options) {
+        if (options === void 0) { options = {}; }
+        if (this._validation && this._children.length !== 0) {
+            throw new Error("in XML document: declaration must be the first"
+                + " child");
+        }
+        var declaration = new XmlDecl_1.default(this, this._validation, options);
+        this._children.push(declaration);
+        return declaration;
+    };
+    /**
+     * Adds a document type definition to this document and returns the new
+     * document type definition.
+     */
+    XmlDocument.prototype.dtd = function (options) {
+        var filteredChildren = this._children.filter(function (value) {
+            return value instanceof XmlElement_1.default;
+        });
+        if (this._validation && filteredChildren.length !== 0) {
+            throw new Error("in XML document: DTD must precede the root"
+                + " element");
+        }
+        var dtd = new XmlDtd_1.default(this, this._validation, options);
+        this._children.push(dtd);
+        return dtd;
+    };
+    /**
+     * Adds the root element to this document and returns the element.
+     */
+    XmlDocument.prototype.element = function (options) {
+        var filteredChildren = this._children.filter(function (value) {
+            return value instanceof XmlElement_1.default;
+        });
+        if (this._validation && filteredChildren.length !== 0) {
+            throw new Error("in XML document: only one root element is"
+                + " permitted");
+        }
+        var element = new XmlElement_1.default(this, this._validation, options);
+        this._children.push(element);
+        return element;
+    };
+    /**
+     * Adds a processing instruction to this document and returns the new
+     * processing instruction.
+     */
+    XmlDocument.prototype.procInst = function (options) {
+        var procInst = new XmlProcInst_1.default(this, this._validation, options);
+        this._children.push(procInst);
+        return procInst;
+    };
+    /**
+     * Returns an XML string representation of this document using the
+     * specified options.
+     */
+    XmlDocument.prototype.toString = function (options) {
+        if (options === void 0) { options = {}; }
+        var filteredChildren = this._children.filter(function (value) {
+            return value instanceof XmlElement_1.default;
+        });
+        if (this._validation && filteredChildren.length !== 1) {
+            throw new Error("in XML document: no more than one root element"
+                + " is permitted");
+        }
+        var optionsObj = new options_1.StringOptions(options);
+        var str = "";
+        for (var _i = 0, _a = this._children; _i < _a.length; _i++) {
+            var node = _a[_i];
+            if (node instanceof XmlDecl_1.default
+                || node instanceof XmlDtd_1.default
+                || node instanceof XmlElement_1.default) {
+                str += node.toString(options);
+            }
+            else {
+                str += node.toString();
+            }
+            if (optionsObj.pretty) {
+                str += optionsObj.newline;
+            }
+        }
+        var len = str.length - optionsObj.newline.length;
+        if (str.substr(len) === optionsObj.newline) {
+            str = str.substr(0, len);
+        }
+        return str;
+    };
+    return XmlDocument;
+}());
+exports.default = XmlDocument;

package/docs/node_modules/xmlcreate/lib/nodes/XmlDtd.d.ts ADDED Viewed

@@ -0,0 +1,147 @@
+/**
+ * Copyright (C) 2016-2019 Michael Kourlas
+ *
+ * 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.
+ */
+import { IStringOptions } from "../options";
+import XmlComment, { IXmlCommentOptions } from "./XmlComment";
+import XmlDtdAttlist, { IXmlDtdAttlistOptions } from "./XmlDtdAttlist";
+import XmlDtdElement, { IXmlDtdElementOptions } from "./XmlDtdElement";
+import XmlDtdEntity, { IXmlDtdEntityOptions } from "./XmlDtdEntity";
+import XmlDtdNotation, { IXmlDtdNotationOptions } from "./XmlDtdNotation";
+import { default as XmlDtdParamEntityRef, IXmlDtdParamEntityRefOptions } from "./XmlDtdParamEntityRef";
+import XmlProcInst, { IXmlProcInstOptions } from "./XmlProcInst";
+/**
+ * The options used to create a new document type definition.
+ */
+export interface IXmlDtdOptions {
+    /**
+     * The name of the DTD.
+     */
+    name: string;
+    /**
+     * The system identifier of the DTD, excluding quotation marks. By default,
+     * no system identifier is included.
+     */
+    sysId?: string;
+    /**
+     * The public identifier of the DTD, excluding quotation marks. If a public
+     * identifier is provided, a system identifier must be provided as well.
+     * By default, no public identifier is included.
+     */
+    pubId?: string;
+}
+/**
+ * Represents an XML document type definition (DTD).
+ *
+ * A document type definition  is structured as follows, where `{name}` is
+ * the name of the DTD, `{sysId}` is the system identifier of the DTD,
+ * `{pubId}` is the public identifier of the DTD, and `{intSubset}` is the
+ * internal subset of the DTD:
+ *
+ * ```xml
+ * <!DOCTYPE {name} SYSTEM "{sysId}" PUBLIC "{pubId}" [
+ *     {intSubset}
+ * ]>
+ * ```
+ *
+ * DTDs can have an unlimited number of comments, attribute-list declarations,
+ * element declarations, entity declarations, notation declarations, parameter
+ * entity references, and processing instructions.
+ */
+export default class XmlDtd<Parent> {
+    private readonly _children;
+    private readonly _parent;
+    private _name;
+    private readonly _validation;
+    private _pubId;
+    private _sysId;
+    constructor(parent: Parent, validation: boolean, options: IXmlDtdOptions);
+    /**
+     * Gets the name of the DTD.
+     */
+    get name(): string;
+    /**
+     * Sets the name of the DTD.
+     */
+    set name(name: string);
+    /**
+     * Gets the public identifier of the DTD.
+     */
+    get pubId(): string | undefined;
+    /**
+     * Sets the public identifier of the DTD.
+     */
+    set pubId(pubId: string | undefined);
+    /**
+     * Gets the system identifier of the DTD.
+     */
+    get sysId(): string | undefined;
+    /**
+     * Sets the system identifier of the DTD.
+     */
+    set sysId(sysId: string | undefined);
+    /**
+     * Adds an attribute-list declaration to this document type declaration
+     * and returns the new attribute-list declaration.
+     */
+    attlist(options: IXmlDtdAttlistOptions): XmlDtdAttlist<this>;
+    /**
+     * Adds a comment to this document type declaration and returns the
+     * new comment.
+     */
+    comment(options: IXmlCommentOptions): XmlComment<this>;
+    /**
+     * Adds an element declaration to this document type declaration
+     * and returns the new element declaration.
+     */
+    element(options: IXmlDtdElementOptions): XmlDtdElement<this>;
+    /**
+     * Adds an entity declaration to this document type declaration
+     * and returns the new entity declaration.
+     */
+    entity(options: IXmlDtdEntityOptions): XmlDtdEntity<this>;
+    /**
+     * Adds a notation declaration to this document type declaration
+     * and returns the new notation declaration.
+     */
+    notation(options: IXmlDtdNotationOptions): XmlDtdNotation<this>;
+    /**
+     * Adds a parameter entity reference to this document type declaration
+     * and returns the new parameter entity reference.
+     */
+    paramEntityRef(options: IXmlDtdParamEntityRefOptions): XmlDtdParamEntityRef<this>;
+    /**
+     * Adds a processing instruction to this document type declaration
+     * and returns the new processing instruction.
+     */
+    procInst(options: IXmlProcInstOptions): XmlProcInst<this>;
+    /**
+     * Returns an XML string representation of this document type declaration.
+     */
+    toString(options?: IStringOptions): string;
+    /**
+     * Returns the parent of this attribute.
+     */
+    up(): Parent;
+    /**
+     * Appends the XML string representation of a public or system identifier
+     * to an existing string.
+     */
+    private appendId;
+}
+/**
+ * Returns true if the specified public identifier only contains characters
+ * permitted by the XML specification.
+ */
+export declare function validatePubId(str: string): boolean;