links-notation 0.11.2 → 0.12.0

package/bun.lock

@@ -1,5 +1,6 @@
 {
   "lockfileVersion": 1,
+  "configVersion": 0,
   "workspaces": {
     "": {
       "name": "@linksplatform/protocols-lino",

package/dist/index.js

@@ -2,7 +2,14 @@
 class Link {
   constructor(id = null, values = null) {
     this.id = id;
-    this.values = values || [];
+    if (values !== null && values !== undefined) {
+      if (!Array.isArray(values)) {
+        throw new TypeError("values must be an array or null");
+      }
+      this.values = values;
+    } else {
+      this.values = [];
+    }
   }
   toString() {
     return this.format(false);
@@ -16,7 +23,9 @@ class Link {
     } else if (this.values.length === 1) {
       return this.values[0];
     } else {
-      const newValues = this.values.map((v) => v.simplify());
+      const newValues = this.values.map((v) => {
+        return v && typeof v.simplify === "function" ? v.simplify() : v;
+      });
       return new Link(this.id, newValues);
     }
   }
@@ -24,21 +33,29 @@ class Link {
     return new Link(null, [this, other]);
   }
   static getValueString(value) {
-    return value.toLinkOrIdString();
+    return value && typeof value.toLinkOrIdString === "function" ? value.toLinkOrIdString() : String(value);
   }
   static escapeReference(reference) {
     if (!reference || reference.trim() === "") {
       return "";
     }
-    const needsSingleQuotes = reference.includes(":") || reference.includes("(") || reference.includes(")") || reference.includes(" ") || reference.includes("\t") || reference.includes(`
-`) || reference.includes("\r") || reference.includes('"');
-    if (needsSingleQuotes) {
+    const hasSingleQuote = reference.includes("'");
+    const hasDoubleQuote = reference.includes('"');
+    const needsQuoting = reference.includes(":") || reference.includes("(") || reference.includes(")") || reference.includes(" ") || reference.includes("\t") || reference.includes(`
+`) || reference.includes("\r") || hasDoubleQuote || hasSingleQuote;
+    if (hasSingleQuote && hasDoubleQuote) {
+      return `'${reference.replace(/'/g, "\\'")}'`;
+    }
+    if (hasDoubleQuote) {
       return `'${reference}'`;
-    } else if (reference.includes("'")) {
+    }
+    if (hasSingleQuote) {
       return `"${reference}"`;
-    } else {
-      return reference;
     }
+    if (needsQuoting) {
+      return `'${reference}'`;
+    }
+    return reference;
   }
   toLinkOrIdString() {
     if (!this.values || this.values.length === 0) {
@@ -51,16 +68,27 @@ class Link {
       return false;
     if (this.id !== other.id)
       return false;
-    if (this.values.length !== other.values.length)
+    const thisValues = this.values || [];
+    const otherValues = other.values || [];
+    if (thisValues.length !== otherValues.length)
       return false;
-    for (let i = 0;i < this.values.length; i++) {
-      if (!this.values[i].equals(other.values[i])) {
-        return false;
+    for (let i = 0;i < thisValues.length; i++) {
+      if (thisValues[i] && typeof thisValues[i].equals === "function") {
+        if (!thisValues[i].equals(otherValues[i])) {
+          return false;
+        }
+      } else {
+        if (thisValues[i] !== otherValues[i]) {
+          return false;
+        }
       }
     }
     return true;
   }
   format(lessParentheses = false, isCompoundValue = false) {
+    if (lessParentheses && typeof lessParentheses === "object" && (lessParentheses.constructor.name === "FormatOptions" || lessParentheses.constructor.name === "FormatConfig")) {
+      return this._formatWithOptions(lessParentheses, isCompoundValue);
+    }
     if (this.id === null && (!this.values || this.values.length === 0)) {
       return lessParentheses ? "" : "()";
     }
@@ -88,8 +116,8 @@ class Link {
     return lessParentheses && !this.needsParentheses(this.id) ? withColon : `(${withColon})`;
   }
   formatValue(value) {
-    if (!value.format) {
-      return Link.escapeReference(value.id || "");
+    if (!value || !value.format) {
+      return Link.escapeReference(value && value.id || "");
     }
     const isCompoundFromPaths = this._isFromPathCombination === true;
     if (isCompoundFromPaths) {
@@ -103,10 +131,110 @@ class Link {
   needsParentheses(str) {
     return str && (str.includes(" ") || str.includes(":") || str.includes("(") || str.includes(")"));
   }
+  _formatWithOptions(options, isCompoundValue = false) {
+    if (this.id === null && (!this.values || this.values.length === 0)) {
+      return options.lessParentheses ? "" : "()";
+    }
+    if (!this.values || this.values.length === 0) {
+      const escapedId = Link.escapeReference(this.id);
+      if (isCompoundValue) {
+        return `(${escapedId})`;
+      }
+      return options.lessParentheses && !this.needsParentheses(this.id) ? escapedId : `(${escapedId})`;
+    }
+    let shouldIndent = false;
+    if (options.shouldIndentByRefCount(this.values.length)) {
+      shouldIndent = true;
+    } else {
+      const valuesStr2 = this.values.map((v) => this.formatValue(v)).join(" ");
+      let testLine;
+      if (this.id !== null) {
+        const idStr2 = Link.escapeReference(this.id);
+        testLine = options.lessParentheses ? `${idStr2}: ${valuesStr2}` : `(${idStr2}: ${valuesStr2})`;
+      } else {
+        testLine = options.lessParentheses ? valuesStr2 : `(${valuesStr2})`;
+      }
+      if (options.shouldIndentByLength(testLine)) {
+        shouldIndent = true;
+      }
+    }
+    if (shouldIndent && options.preferInline === false) {
+      return this._formatIndented(options);
+    }
+    const valuesStr = this.values.map((v) => this.formatValue(v)).join(" ");
+    if (this.id === null) {
+      if (options.lessParentheses) {
+        const allSimple = this.values.every((v) => !v.values || v.values.length === 0);
+        if (allSimple) {
+          return this.values.map((v) => Link.escapeReference(v.id)).join(" ");
+        }
+        return valuesStr;
+      }
+      return `(${valuesStr})`;
+    }
+    const idStr = Link.escapeReference(this.id);
+    const withColon = `${idStr}: ${valuesStr}`;
+    return options.lessParentheses && !this.needsParentheses(this.id) ? withColon : `(${withColon})`;
+  }
+  _formatIndented(options) {
+    if (this.id === null) {
+      const lines2 = this.values.map((v) => options.indentString + this.formatValue(v));
+      return lines2.join(`
+`);
+    }
+    const idStr = Link.escapeReference(this.id);
+    const lines = [`${idStr}:`];
+    for (const v of this.values) {
+      lines.push(options.indentString + this.formatValue(v));
+    }
+    return lines.join(`
+`);
+  }
+}
+function _groupConsecutiveLinks(links) {
+  if (!links || links.length === 0) {
+    return links;
+  }
+  const grouped = [];
+  let i = 0;
+  while (i < links.length) {
+    const current = links[i];
+    if (current.id !== null && current.values && current.values.length > 0) {
+      const sameIdValues = [...current.values];
+      let j = i + 1;
+      while (j < links.length) {
+        const nextLink = links[j];
+        if (nextLink.id === current.id && nextLink.values && nextLink.values.length > 0) {
+          sameIdValues.push(...nextLink.values);
+          j++;
+        } else {
+          break;
+        }
+      }
+      if (j > i + 1) {
+        const groupedLink = new Link(current.id, sameIdValues);
+        grouped.push(groupedLink);
+        i = j;
+        continue;
+      }
+    }
+    grouped.push(current);
+    i++;
+  }
+  return grouped;
 }
 function formatLinks(links, lessParentheses = false) {
   if (!links || links.length === 0)
     return "";
+  if (lessParentheses && typeof lessParentheses === "object" && (lessParentheses.constructor.name === "FormatOptions" || lessParentheses.constructor.name === "FormatConfig")) {
+    const options = lessParentheses;
+    let linksToFormat = links;
+    if (options.groupConsecutive) {
+      linksToFormat = _groupConsecutiveLinks(links);
+    }
+    return linksToFormat.map((link) => link.format(options)).join(`
+`);
+  }
   return links.map((link) => link.format(lessParentheses)).join(`
 `);
 }
@@ -1532,27 +1660,39 @@ function peg$parse(input, options) {
 
 // src/Parser.js
 class Parser {
-  constructor() {}
+  constructor(options = {}) {
+    this.maxInputSize = options.maxInputSize || 10 * 1024 * 1024;
+    this.maxDepth = options.maxDepth || 1000;
+  }
   parse(input) {
+    if (typeof input !== "string") {
+      throw new TypeError("Input must be a string");
+    }
+    if (input.length > this.maxInputSize) {
+      throw new Error(`Input size exceeds maximum allowed size of ${this.maxInputSize} bytes`);
+    }
     try {
       const rawResult = peg$parse(input);
       return this.transformResult(rawResult);
     } catch (error) {
-      throw new Error(`Parse error: ${error.message}`);
+      const parseError = new Error(`Parse error: ${error.message}`);
+      parseError.cause = error;
+      parseError.location = error.location;
+      throw parseError;
     }
   }
   transformResult(rawResult) {
     const links = [];
     const items = Array.isArray(rawResult) ? rawResult : [rawResult];
     for (const item of items) {
-      if (item) {
+      if (item !== null && item !== undefined) {
         this.collectLinks(item, [], links);
       }
     }
     return links;
   }
   collectLinks(item, parentPath, result) {
-    if (!item)
+    if (item === null || item === undefined)
       return;
     if (item.children && item.children.length > 0) {
       if (item.id && (!item.values || item.values.length === 0)) {
@@ -1609,7 +1749,7 @@ class Parser {
     return combined;
   }
   transformLink(item) {
-    if (!item)
+    if (item === null || item === undefined)
       return null;
     if (item instanceof Link) {
       return item;
@@ -1625,9 +1765,39 @@ class Parser {
     return new Link(item.id || null, []);
   }
 }
+// src/FormatOptions.js
+class FormatOptions {
+  constructor(options = {}) {
+    this.lessParentheses = options.lessParentheses ?? false;
+    this.maxLineLength = options.maxLineLength ?? 80;
+    this.indentLongLines = options.indentLongLines ?? false;
+    this.maxInlineRefs = options.maxInlineRefs ?? null;
+    this.groupConsecutive = options.groupConsecutive ?? false;
+    this.indentString = options.indentString ?? "  ";
+    this.preferInline = options.preferInline ?? true;
+  }
+  shouldIndentByLength(line) {
+    if (!this.indentLongLines) {
+      return false;
+    }
+    return line.length > this.maxLineLength;
+  }
+  shouldIndentByRefCount(refCount) {
+    if (this.maxInlineRefs === null) {
+      return false;
+    }
+    return refCount > this.maxInlineRefs;
+  }
+}
+
+// src/FormatConfig.js
+class FormatConfig extends FormatOptions {
+}
 export {
   formatLinks,
   Parser,
   LinksGroup,
-  Link
+  Link,
+  FormatOptions,
+  FormatConfig
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "links-notation",
-  "version": "0.11.2",
+  "version": "0.12.0",
   "description": "Links Notation parser for JavaScript",
   "main": "dist/index.js",
   "type": "module",

package/src/FormatConfig.js

@@ -0,0 +1,19 @@
+/**
+ * FormatConfig is an alias for FormatOptions to maintain API consistency
+ * with the Python implementation.
+ *
+ * JavaScript uses 'FormatOptions' internally, but exports 'FormatConfig'
+ * as the primary name to match Python's naming convention.
+ */
+import { FormatOptions } from './FormatOptions.js';
+
+/**
+ * FormatConfig for Lino notation formatting.
+ *
+ * This is an alias for FormatOptions to maintain API consistency across languages.
+ * Python uses 'FormatConfig', so this export provides the same name for JavaScript.
+ */
+export class FormatConfig extends FormatOptions {
+  // FormatConfig inherits all functionality from FormatOptions
+  // No additional implementation needed - this is purely for naming consistency
+}

package/src/FormatOptions.js

@@ -0,0 +1,52 @@
+/**
+ * FormatOptions for Lino notation formatting.
+ *
+ * Provides configuration options for controlling how Link objects are formatted.
+ */
+export class FormatOptions {
+  /**
+   * Create a new FormatOptions instance
+   * @param {Object} options - Configuration options
+   * @param {boolean} [options.lessParentheses=false] - If true, omit parentheses where safe
+   * @param {number} [options.maxLineLength=80] - Maximum line length before auto-indenting
+   * @param {boolean} [options.indentLongLines=false] - If true, indent lines exceeding maxLineLength
+   * @param {number|null} [options.maxInlineRefs=null] - Maximum number of references before auto-indenting
+   * @param {boolean} [options.groupConsecutive=false] - If true, group consecutive links with same ID
+   * @param {string} [options.indentString="  "] - String to use for indentation
+   * @param {boolean} [options.preferInline=true] - If true, prefer inline format when under thresholds
+   */
+  constructor(options = {}) {
+    this.lessParentheses = options.lessParentheses ?? false;
+    this.maxLineLength = options.maxLineLength ?? 80;
+    this.indentLongLines = options.indentLongLines ?? false;
+    this.maxInlineRefs = options.maxInlineRefs ?? null;
+    this.groupConsecutive = options.groupConsecutive ?? false;
+    this.indentString = options.indentString ?? "  ";
+    this.preferInline = options.preferInline ?? true;
+  }
+
+  /**
+   * Check if line should be indented based on length
+   * @param {string} line - The line to check
+   * @returns {boolean} True if line should be indented based on length threshold
+   */
+  shouldIndentByLength(line) {
+    if (!this.indentLongLines) {
+      return false;
+    }
+    // Count printable unicode characters
+    return line.length > this.maxLineLength;
+  }
+
+  /**
+   * Check if link should be indented based on reference count
+   * @param {number} refCount - Number of references in the link
+   * @returns {boolean} True if link should be indented based on reference count threshold
+   */
+  shouldIndentByRefCount(refCount) {
+    if (this.maxInlineRefs === null) {
+      return false;
+    }
+    return refCount > this.maxInlineRefs;
+  }
+}