All files / src jsapi.ts

24.79% Statements 30/121
5.21% Branches 5/96
22.73% Functions 5/22
24.58% Lines 29/118
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333                                    1x                           3x 3x 3x 3x 3x 3x 3x 3x           1x                                                         1x                             1x                     1x 1x               1x                         1x                                           1x 1x 1x                                     1x                                                                                                       1x                             1x                                                       1x                                           1x                                         1x 1x 1x                             1x                     1x  
export interface Attr {
  name: string;
  value: string;
  prefix: string;
  local: string;
}
 
export interface Options {
  content?: JsApi[];
  parentNode?: JsApi;
  elem?: string;
  prefix?: string;
  local?: string;
  attrs?: { [name: string]: Attr };
  comment?: { text: string };
  processingInstruction?: { name: string; body: string };
}
 
export class JsApi implements Options {
  content?: JsApi[];
  parentNode?: JsApi;
  elem?: string;
  prefix?: string;
  local?: string;
  attrs?: { [name: string]: Attr };
  comment?: { text: string };
  processingInstruction?: { name: string; body: string };
 
  // TODO: avoid this caching hackery
  pathJS?: Array<{ instruction: string; data?: number[] }>;
 
  constructor(arg: Options) {
    this.content = arg.content;
    this.parentNode = arg.parentNode;
    this.elem = arg.elem;
    this.prefix = arg.prefix;
    this.local = arg.local;
    this.attrs = arg.attrs;
    this.comment = arg.comment;
    this.processingInstruction = arg.processingInstruction;
  }
 
  /**
   * Perform a deep clone of this node.
   */
  clone() {
    // Deep-clone node data.
    const nodeData = JSON.parse(
      JSON.stringify({
        elem: this.elem,
        prefix: this.prefix,
        local: this.local,
        attrs: this.attrs,
        comment: this.comment,
        processingInstruction: this.processingInstruction,
        pathJS: this.pathJS,
      }),
    );
    const clonedNode = new JsApi({ ...nodeData, parentNode: this.parentNode });
    if (this.content) {
      clonedNode.content = this.content.map(childNode => {
        const clonedChild = childNode.clone();
        clonedChild.parentNode = clonedNode;
        return clonedChild;
      });
    }
    return clonedNode;
  }
 
  /**
   * Determine if item is an element (any, with a specific name or in a names array).
   * @param {String|Array} [elemNames] element name or names arrays
   * @return {Boolean}
   */
  isElem(elemNames?: string | string[]) {
    if (!elemNames) {
      return !!this.elem;
    }
    if (Array.isArray(elemNames)) {
      return !!this.elem && elemNames.indexOf(this.elem) >= 0;
    }
    return !!this.elem && this.elem === elemNames;
  }
 
  /**
   * Renames an element.
   * @param {String} name new element name
   * @return {Object} element
   */
  renameElem(name: string) {
    if (name && typeof name === 'string') {
      this.elem = this.local = name;
    }
    return this;
  }
 
  /**
   * Determine if element is empty.
   * @return {Boolean}
   */
  isEmpty() {
    return !this.content || !this.content.length;
  }
 
  /**
   * Find the closest ancestor of the current element.
   * @param elemName
   * @return {Object}
   */
  closestElem(elemName: string) {
    let node: JsApi = this;
    while ((node = node.parentNode) && !node.isElem(elemName)) {}
    return node;
  }
 
  /**
   * Changes content by removing elements and/or adding new elements.
   * @param {Number} start Index at which to start changing the content.
   * @param {Number} n Number of elements to remove.
   * @param {Array|Object} [insertion] Elements to add to the content.
   * @return {Array} Removed elements.
   */
  spliceContent(start: number, n: number, insertion: JsApi[]) {
    if (arguments.length < 2) {
      return [];
    }
    if (!Array.isArray(insertion)) {
      insertion = Array.apply(undefined, arguments).slice(2);
    }
    insertion.forEach(function(inner) {
      inner.parentNode = this;
    }, this);
    return this.content.splice.apply(
      this.content,
      ([start, n] as Array<number | JsApi>).concat(insertion),
    );
  }
 
  /**
   * Determine if element has an attribute (any, or by name or by name + value).
   * @param {String} [name] attribute name
   * @param {String} [val] attribute value (will be toString()'ed)
   * @return {Boolean}
   */
  hasAttr(name?: string, val?: any) {
    Eif (!this.attrs || !Object.keys(this.attrs).length) {
      return false;
    }
    if (!arguments.length) {
      return !!this.attrs;
    }
    if (val !== undefined) {
      return !!this.attrs[name] && this.attrs[name].value === val.toString();
    }
    return !!this.attrs[name];
  }
 
  /**
   * Determine if element has an attribute by local name
   * (any, or by name or by name + value).
   *
   * @param {String} [localName] local attribute name
   * @param {Number|String|RegExp|Function} [val] attribute value (will be toString()'ed or executed, otherwise ignored)
   * @return {Boolean}
   */
  hasAttrLocal(localName?: string, val?: number | string | RegExp | Function) {
    if (!this.attrs || !Object.keys(this.attrs).length) {
      return false;
    }
    if (!arguments.length) {
      return !!this.attrs;
    }
    let callback: Function;
    // tslint:disable-next-line:triple-equals no-null-keyword
    switch (val != null && val.constructor && val.constructor.name) {
      case 'Number': // same as String
      case 'String':
        callback = stringValueTest;
        break;
      case 'RegExp':
        callback = regexpValueTest;
        break;
      case 'Function':
        callback = funcValueTest;
        break;
      default:
        callback = nameTest;
        break;
    }
    return this.someAttr(callback);
 
    function stringValueTest(attr) {
      // tslint:disable-next-line:triple-equals
      return attr.local === localName && val == attr.value;
    }
 
    function regexpValueTest(attr) {
      const valRegExp = val as RegExp;
      return attr.local === localName && valRegExp.test(attr.value);
    }
 
    function funcValueTest(attr) {
      const valFn = val as Function;
      return attr.local === localName && valFn(attr.value);
    }
 
    function nameTest(attr) {
      return attr.local === localName;
    }
  }
 
  /**
   * Get a specific attribute from an element (by name or name + value).
   * @param {String} name attribute name
   * @param {String} [val] attribute value (will be toString()'ed)
   * @return {Object|Undefined}
   */
  attr(name: string, val?: string) {
    if (!this.hasAttr() || !arguments.length) {
      return undefined;
    }
    if (val !== undefined) {
      return this.hasAttr(name, val) ? this.attrs[name] : undefined;
    }
    return this.attrs[name];
  }
 
  /**
   * Get computed attribute value from an element.
   * @param {String} name attribute name
   * @return {Object|Undefined}
   */
  computedAttr(name: string, val?: any) {
    if (!arguments.length) {
      return;
    }
 
    let elem: JsApi;
    for (
      elem = this;
      elem && (!elem.hasAttr(name) || !elem.attr(name).value);
      elem = elem.parentNode
    ) {}
 
    // tslint:disable-next-line:triple-equals no-null-keyword
    if (val != null) {
      return elem ? elem.hasAttr(name, val) : false;
    } else if (elem && elem.hasAttr(name)) {
      return elem.attrs[name].value;
    } else {
      return undefined;
    }
  }
 
  /**
   * Remove a specific attribute.
   * @param {String|Array} name attribute name
   * @param {String} [val] attribute value
   * @return {Boolean}
   */
  removeAttr(name) {
    if (!arguments.length) {
      return false;
    }
    if (Array.isArray(name)) {
      name.forEach(this.removeAttr, this);
    }
    if (!this.hasAttr(name)) {
      return false;
    }
    delete this.attrs[name];
    if (!Object.keys(this.attrs).length) {
      delete this.attrs;
    }
    return true;
  }
 
  /**
   * Add attribute.
   * @param {Object} [attr={}] attribute object
   * @return {Object|Boolean} created attribute or false if no attr was passed in
   */
  addAttr(attr) {
    attr = attr || {};
    if (
      attr.name === undefined ||
      attr.prefix === undefined ||
      attr.local === undefined
    ) {
      return false;
    }
    this.attrs = this.attrs || {};
    this.attrs[attr.name] = attr;
    return this.attrs[attr.name];
  }
 
  /**
   * Iterates over all attributes.
   *
   * @param {Function} callback callback
   * @param {Object} [context] callback context
   * @return {Boolean} false if there are no any attributes
   */
  eachAttr(callback: Function, context?: any) {
    Eif (!this.hasAttr()) {
      return false;
    }
    for (const name of Object.keys(this.attrs)) {
      callback.call(context, this.attrs[name]);
    }
    return true;
  }
 
  /**
   * Tests whether some attribute passes the test.
   *
   * @param {Function} callback callback
   * @param {Object} [context] callback context
   * @return {Boolean} false if there are no any attributes
   */
  someAttr(callback: Function, context?: any) {
    if (!this.hasAttr()) {
      return false;
    }
    for (const name of Object.keys(this.attrs)) {
      if (callback.call(context, this.attrs[name])) {
        return true;
      }
    }
    return false;
  }
}