properties-file 3.3.18 → 3.4.0

package/lib/cjs/package.json

@@ -0,0 +1 @@
+{ "type": "commonjs" }

package/lib/{properties-file.d.ts → cjs/properties-file.d.ts}

@@ -1,7 +1,7 @@
-/** This allows to get the correct type when using `import` on `.properties` files. */
-declare module '*.properties' {
-  const properties: {
-    readonly [key: string]: string
-  }
-  export default properties
-}
+/** This allows to get the correct type when using `import` on `.properties` files. */
+declare module '*.properties' {
+  const properties: {
+    readonly [key: string]: string
+  }
+  export default properties
+}

package/lib/cjs/properties.js

@@ -0,0 +1 @@
+"use strict";var __values=this&&this.__values||function(e){var t="function"==typeof Symbol&&Symbol.iterator,r=t&&e[t],o=0;if(r)return r.call(e);if(e&&"number"==typeof e.length)return{next:function(){return e&&o>=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")},__read=this&&this.__read||function(e,t){var r="function"==typeof Symbol&&e[Symbol.iterator];if(!r)return e;var o,i,n=r.call(e),s=[];try{for(;(void 0===t||t-- >0)&&!(o=n.next()).done;)s.push(o.value)}catch(e){i={error:e}}finally{try{o&&!o.done&&(r=n.return)&&r.call(n)}finally{if(i)throw i.error}}return s};Object.defineProperty(exports,"__esModule",{value:!0}),exports.KeyCollisions=exports.Properties=exports.getFirstEolCharacter=exports.DEFAULT_END_OF_LINE_CHARACTER=exports.BOM_CODE_POINT=exports.BOM=void 0;var property_1=require("./property"),property_line_1=require("./property-line");exports.BOM="\ufeff",exports.BOM_CODE_POINT=exports.BOM.codePointAt(0),exports.DEFAULT_END_OF_LINE_CHARACTER="\n";var getFirstEolCharacter=function(e){var t=e.indexOf("\n");return t<0?void 0:"".concat("\r"===e[t-1]?"\r":"","\n")};exports.getFirstEolCharacter=getFirstEolCharacter;var Properties=function(){function e(e){var t;this.collection=[],this.keyLineNumbers={};var r="string"==typeof e?e:e.toString();this.hasBom=r.codePointAt(0)===exports.BOM_CODE_POINT,this.eolCharacter=null!==(t=(0,exports.getFirstEolCharacter)(r))&&void 0!==t?t:exports.DEFAULT_END_OF_LINE_CHARACTER,this.lines=(this.hasBom?r.slice(1):r).split(/\r?\n/),this.parseLines()}return e.prototype.parseLines=function(){var e,t;this.collection=[],this.keyLineNumbers={};var r,o,i=0;try{for(var n=__values(this.lines),s=n.next();!s.done;s=n.next()){var l=s.value;i++;var a=new property_line_1.PropertyLine(l,!!r);if(r){if(r.addLine(a),a.isContinuing)continue}else{if(a.isComment||a.isBlank)continue;if(r=new property_1.Property(a,i,o),a.isContinuing)continue}this.addToCollection(r),o=r,r=void 0}}catch(t){e={error:t}}finally{try{s&&!s.done&&(t=n.return)&&t.call(n)}finally{if(e)throw e.error}}},e.prototype.addToCollection=function(e){var t;e.setKeyAndValue(),(null===(t=this.keyLineNumbers[e.key])||void 0===t?void 0:t.length)?(this.keyLineNumbers[e.key].push(e.startingLineNumber),e.hasKeyCollisions=!0,e.keyCollisionLines=this.keyLineNumbers[e.key],this.collection=this.collection.filter((function(t){return t.key!==e.key}))):this.keyLineNumbers[e.key]=[e.startingLineNumber],this.collection.push(e)},e.prototype.getKeyCollisions=function(){var e,t,r=[];try{for(var o=__values(Object.entries(this.keyLineNumbers)),i=o.next();!i.done;i=o.next()){var n=__read(i.value,2),s=n[0],l=n[1];l.length>1&&r.push(new KeyCollisions(s,l))}}catch(t){e={error:t}}finally{try{i&&!i.done&&(t=o.return)&&t.call(o)}finally{if(e)throw e.error}}return r},e.prototype.toObject=function(){var e={};return this.collection.forEach((function(t){e[t.key]=t.value})),e},e.prototype.format=function(e){return"".concat(this.hasBom?exports.BOM:"").concat(this.lines.join(e||this.eolCharacter))},e}();exports.Properties=Properties;var KeyCollisions=function(){function e(e,t){this.key=e,this.startingLineNumbers=t}return e.prototype.getApplicableLineNumber=function(){return this.startingLineNumbers.slice(-1)[0]},e}();exports.KeyCollisions=KeyCollisions;

package/lib/{property-line.d.ts → cjs/property-line.d.ts}

@@ -2,7 +2,7 @@
  * Object representing a line from the content of .properties file.
  */
 export declare class PropertyLine {
-    /** The line content, minus the trailing \ that identifies that the line is continuing. */
+    /** The line content, minus the trailing `\` that identifies that the line is continuing. */
     content: string;
     /** True if the line is continuing to the next line, otherwise false. */
     isContinuing: boolean;

package/lib/cjs/property-line.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.PropertyLine=void 0;var PropertyLine=function(t,i){if(this.isContinuing=!1,this.isBlank=!1,this.isComment=!1,this.content=t.trimStart(),this.isMultiline=i,0===this.content.length)this.isBlank=!0;else if(this.isMultiline||(this.isComment=!!/^[!#]/.test(this.content)),!this.isComment){var s=this.content.match(/(?<backslashes>\\+)$/);(null==s?void 0:s.groups)&&(this.isContinuing=!!(s.groups.backslashes.length%2),this.isContinuing&&(this.content=this.content.slice(0,-1)))}};exports.PropertyLine=PropertyLine;

package/lib/cjs/property.js

@@ -0,0 +1 @@
+"use strict";var __values=this&&this.__values||function(t){var e="function"==typeof Symbol&&Symbol.iterator,i=e&&t[e],s=0;if(i)return i.call(t);if(t&&"number"==typeof t.length)return{next:function(){return t&&s>=t.length&&(t=void 0),{value:t&&t[s++],done:!t}}};throw new TypeError(e?"Object is not iterable.":"Symbol.iterator is not defined.")};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Property=void 0;var unescape_1=require("./unescape"),Property=function(){function t(t,e,i){this.key="",this.escapedKey="",this.hasNoKey=!1,this.hasMultilineKey=!1,this.keyCollisionLines=[],this.hasKeyCollisions=!1,this.value="",this.escapedValue="",this.hasNoValue=!1,this.newlinePositions=[],this.linesContent=t.content,this.startingLineNumber=e,this.endingLineNumber=e,this.previousProperty=i,null==i||i.setNextProperty(this)}return t.prototype.setNextProperty=function(t){this.nextProperty=t},t.prototype.addLine=function(t){this.linesContent.length>0&&(this.newlinePositions.push(this.linesContent.length),this.endingLineNumber++),this.linesContent+=t.content},t.prototype.setKeyAndValue=function(){this.findSeparator(),void 0!==this.separatorPosition&&void 0!==this.separatorLength?(this.hasNoKey||(this.escapedKey=this.linesContent.slice(0,this.separatorPosition),this.key=this.unescapeLine(this.escapedKey,this.startingLineNumber)),this.hasNoValue||(this.escapedValue=this.linesContent.slice(this.separatorPosition+this.separatorLength),this.value=this.unescapeLine(this.escapedValue,this.startingLineNumber))):this.hasNoValue&&(this.escapedKey=this.linesContent,this.key=this.unescapeLine(this.escapedKey,this.startingLineNumber))},t.prototype.unescapeLine=function(t,e){try{return(0,unescape_1.unescapeContent)(t)}catch(t){throw new Error("".concat(t.message," in property starting at line ").concat(e))}},t.prototype.findSeparator=function(){var t,e,i,s;if(!(this.hasNoKey||this.hasNoValue||this.separatorPosition)){try{for(var n=__values(this.linesContent.matchAll(/[\t\f :=]/g)),o=n.next();!o.done;o=n.next()){var r=o.value.index,a=this.linesContent.slice(0,r).match(/(?<backslashes>\\+)$/);if(null==a?void 0:a.groups)if(!!(a.groups.backslashes.length%2))continue;var h="";this.separatorPosition=r;var l=this.linesContent.slice(r),p=l.match(/^(?<whitespace>[\t\n\v\f\r ]+)/),u=(null===(i=null==p?void 0:p.groups)||void 0===i?void 0:i.whitespace)||"";if(u.length>0&&(h+=u,l=l.slice(u.length)),/[:=]/.test(l[0])){h+=l[0];var c=(l=l.slice(1)).match(/^(?<whitespace>[\t\n\v\f\r ]+)/);h+=(null===(s=null==c?void 0:c.groups)||void 0===s?void 0:s.whitespace)||""}this.separatorLength=h.length,this.valuePosition=this.separatorPosition+this.separatorLength,this.separator=this.linesContent.slice(this.separatorPosition,this.separatorPosition+this.separatorLength),r||(this.hasNoKey=!0);break}}catch(e){t={error:e}}finally{try{o&&!o.done&&(e=n.return)&&e.call(n)}finally{if(t)throw t.error}}void 0===this.separatorPosition?this.hasNoValue=!0:this.newlinePositions.length>0&&this.newlinePositions[0]<this.separatorPosition&&(this.hasMultilineKey=!0)}},t}();exports.Property=Property;

package/lib/cjs/unescape/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.unescapeContent=void 0;var unescapeContent=function(e){return e.replace(/\\[^u]|\\u.{4}/g,(function(e){var r=e.charAt(1);switch(r){case"f":return"\f";case"n":return"\n";case"r":return"\r";case"t":return"\t";case"u":var t=e.slice(2,6);if(!/[\da-f]{4}/i.test(t))throw new Error("malformed escaped unicode characters '\\u".concat(t,"'"));return String.fromCodePoint(Number.parseInt(t,16));default:return r}}))};exports.unescapeContent=unescapeContent;

package/lib/esm/editor/index.d.ts

@@ -0,0 +1,139 @@
+import { Properties } from '../properties';
+/** The default separator between keys and values. */
+export declare const DEFAULT_SEPARATOR = "=";
+/** The default character used as comment delimiter. */
+export declare const DEFAULT_COMMENT_DELIMITER = "#";
+/** Characters that can be used as key-value pair separators. */
+export type KeyValuePairSeparator = ' ' | ':' | '=';
+/** Characters that can be used as comment delimiters. */
+export type CommentDelimiter = '#' | '!';
+/** Options on the `Properties.insert` method. */
+export type InsertOptions = {
+    /** The name of the key to insert before or after. If the key not found, the new property will not be inserted. */
+    referenceKey?: string;
+    /** The position of the insertion related to the `referenceKey` (default is `after`) */
+    position?: 'before' | 'after';
+    /** Escape unicode characters into ISO-8859-1 compatible encoding? */
+    escapeUnicode?: boolean;
+    /** The key/value separator character. */
+    separator?: KeyValuePairSeparator;
+    /** A comment to insert before. */
+    comment?: string;
+    /** The comment's delimiter. */
+    commentDelimiter?: CommentDelimiter;
+};
+/** Options on the `Properties.insertComment` method. */
+export type InsertCommentOptions = {
+    /** The name of the key to insert before or after. If the key not found, the new property will not be inserted. */
+    referenceKey?: string;
+    /** The position of the insertion related to the `referenceKey` (default is `after`) */
+    position?: 'before' | 'after';
+    /** The comment's delimiter. */
+    commentDelimiter?: CommentDelimiter;
+};
+/** Options on the `Properties.update` method. */
+export type UpdateOptions = {
+    /** Optionally replace the existing value with a new value. */
+    newValue?: string;
+    /** Optionally replace the existing key with a new key name. */
+    newKey?: string;
+    /** Escape unicode characters into ISO-8859-1 compatible encoding? */
+    escapeUnicode?: boolean;
+    /** A key/value separator character. */
+    separator?: ' ' | ':' | '=';
+    /** Optionally insert a new comment, or replace the existing one (including white-space characters). */
+    newComment?: string;
+    /** The comment's delimiter. */
+    commentDelimiter?: CommentDelimiter;
+};
+/** Options on the `Properties.upsert` method. */
+export type UpsertOptions = {
+    /** Escape unicode characters into ISO-8859-1 compatible encoding? */
+    escapeUnicode?: boolean;
+    /** The key/value separator character. */
+    separator?: KeyValuePairSeparator;
+    /** A comment to insert before. */
+    comment?: string;
+    /** The comment's delimiter. */
+    commentDelimiter?: CommentDelimiter;
+};
+/**
+ * A .properties file editor.
+ */
+export declare class PropertiesEditor extends Properties {
+    /** Is line parsing required to re-async the object's properties? */
+    private needsLineParsing;
+    /**
+     * Create `PropertiesEditor` object.
+     *
+     * @param content - The content of a `.properties` file.
+     */
+    constructor(content: string);
+    /**
+     * Parse the `.properties` content line by line only when needed.
+     */
+    private parseLinesIfNeeded;
+    /**
+     * Insert a new property in the existing object (by default it will be at the end).
+     *
+     * @param key - A property key (unescaped).
+     * @param value - A property value (unescaped).
+     * @param options - Additional options.
+     *
+     * @returns True if the key was inserted, otherwise false.
+     */
+    insert(key: string, value: string, options?: InsertOptions): boolean;
+    /**
+     * Insert a new comment in the existing object (by default it will be at the end).
+     *
+     * @param comment - The comment to add.
+     * @param options - Additional options.
+     *
+     * @returns True if the comment was inserted, otherwise false.
+     */
+    insertComment(comment: string, options?: InsertCommentOptions): boolean;
+    /**
+     * Delete the last occurrence of a given key from the existing object.
+     *
+     * @param key - The name of the key to delete.
+     * @param deleteCommentsAndWhiteSpace - By default, comments and white-space characters before the key will be deleted.
+     *
+     * @returns True if the key was deleted, otherwise false.
+     */
+    delete(key: string, deleteCommentsAndWhiteSpace?: boolean): boolean;
+    /**
+     * Restore the original newline characters of a key.
+     *
+     * @param property - A property object.
+     *
+     * @returns The key with its original newlines characters restored.
+     */
+    private getKeyWithNewlines;
+    /**
+     * Restore the original newline characters of a value.
+     *
+     * @param property - A property object.
+     *
+     * @returns The value with its original newlines characters restored.
+     */
+    private getValueWithNewlines;
+    /**
+     * Update the last occurrence of a given key from the existing object.
+     *
+     * @param key - The name of the key to update.
+     * @param options - Additional options.
+     *
+     * @returns True if the key was updated, otherwise false.
+     */
+    update(key: string, options?: UpdateOptions): boolean;
+    /**
+     * Update a key if it exist, otherwise add it at the end.
+     *
+     * @param key - A property key (unescaped).
+     * @param value - A property value (unescaped).
+     * @param options - Additional options.
+     *
+     * @returns True if the key was updated or inserted, otherwise false.
+     */
+    upsert(key: string, value: string, options?: UpsertOptions): boolean;
+}

package/lib/esm/editor/index.js

@@ -0,0 +1 @@
+var __extends=this&&this.__extends||function(){var e=function(n,r){return e=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,n){e.__proto__=n}||function(e,n){for(var r in n)Object.prototype.hasOwnProperty.call(n,r)&&(e[r]=n[r])},e(n,r)};return function(n,r){if("function"!=typeof r&&null!==r)throw new TypeError("Class extends value "+String(r)+" is not a constructor or null");function t(){this.constructor=n}e(n,r),n.prototype=null===r?Object.create(r):(t.prototype=r.prototype,new t)}}(),__read=this&&this.__read||function(e,n){var r="function"==typeof Symbol&&e[Symbol.iterator];if(!r)return e;var t,i,o=r.call(e),a=[];try{for(;(void 0===n||n-- >0)&&!(t=o.next()).done;)a.push(t.value)}catch(e){i={error:e}}finally{try{t&&!t.done&&(r=o.return)&&r.call(o)}finally{if(i)throw i.error}}return a},__spreadArray=this&&this.__spreadArray||function(e,n,r){if(r||2===arguments.length)for(var t,i=0,o=n.length;i<o;i++)!t&&i in n||(t||(t=Array.prototype.slice.call(n,0,i)),t[i]=n[i]);return e.concat(t||Array.prototype.slice.call(n))};import{escapeKey,escapeValue}from"../escape";import{Properties}from"../properties";export var DEFAULT_SEPARATOR="=";export var DEFAULT_COMMENT_DELIMITER="#";var PropertiesEditor=function(e){function n(n){var r=e.call(this,n)||this;return r.needsLineParsing=!1,r}return __extends(n,e),n.prototype.parseLinesIfNeeded=function(){this.needsLineParsing&&(this.parseLines(),this.needsLineParsing=!1)},n.prototype.insert=function(e,n,r){var t,i,o,a=(null==r?void 0:r.escapeUnicode)||!1,s=(null==r?void 0:r.separator)?" "===r.separator?" ":" ".concat(r.separator," "):" ".concat(DEFAULT_SEPARATOR," ").replace("  "," "),c=null==r?void 0:r.referenceKey,l=(null==r?void 0:r.position)||"after";c&&this.parseLinesIfNeeded();var p=e.split(/\r?\n/).map((function(e){return escapeKey(e,a)})).join("\\\n"),d=n.split(/\r?\n/).map((function(e){return escapeValue(e,a)})).join("\\\n"),u="".concat((null==r?void 0:r.commentDelimiter)||DEFAULT_COMMENT_DELIMITER," "),_=void 0===(null==r?void 0:r.comment)?"":"".concat("".concat(u).concat(r.comment).split(/\r?\n/).join("\n".concat(u)),"\n"),v="".concat(_).concat(p).concat(s).concat(d).split(/\n/);if(void 0===c)return(t=this.lines).push.apply(t,__spreadArray([],__read(v),!1)),this.needsLineParsing=!0,!0;var y=__spreadArray([],__read(this.collection),!1).reverse().find((function(e){return e.key===c}));if(y){var f="after"===l?y.endingLineNumber:null!==(o=null===(i=y.previousProperty)||void 0===i?void 0:i.endingLineNumber)&&void 0!==o?o:0;return this.lines=__spreadArray(__spreadArray(__spreadArray([],__read(this.lines.slice(0,f)),!1),__read(v),!1),__read(this.lines.slice(f)),!1),this.needsLineParsing=!0,!0}return!1},n.prototype.insertComment=function(e,n){var r,t,i,o=null==n?void 0:n.referenceKey,a=(null==n?void 0:n.position)||"after";o&&this.parseLinesIfNeeded();var s="".concat((null==n?void 0:n.commentDelimiter)||DEFAULT_COMMENT_DELIMITER," "),c="".concat(s).concat(e).replace(/\r?\n/g,"\n".concat(s)).split(/\n/);if(void 0===o)return(r=this.lines).push.apply(r,__spreadArray([],__read(c),!1)),this.needsLineParsing=!0,!0;var l=__spreadArray([],__read(this.collection),!1).reverse().find((function(e){return e.key===o}));if(l){var p="after"===a?l.endingLineNumber:null!==(i=null===(t=l.previousProperty)||void 0===t?void 0:t.endingLineNumber)&&void 0!==i?i:0;return this.lines=__spreadArray(__spreadArray(__spreadArray([],__read(this.lines.slice(0,p)),!1),__read(c),!1),__read(this.lines.slice(p)),!1),this.needsLineParsing=!0,!0}return!1},n.prototype.delete=function(e,n){var r,t;void 0===n&&(n=!0),this.parseLinesIfNeeded();var i=__spreadArray([],__read(this.collection),!1).reverse().find((function(n){return n.key===e}));if(i){var o=n?null!==(t=null===(r=i.previousProperty)||void 0===r?void 0:r.endingLineNumber)&&void 0!==t?t:0:i.startingLineNumber-1,a=i.endingLineNumber;return this.lines=__spreadArray(__spreadArray([],__read(this.lines.slice(0,o)),!1),__read(this.lines.slice(a)),!1),this.needsLineParsing=!0,!0}return!1},n.prototype.getKeyWithNewlines=function(e){return 0===e.newlinePositions.length?e.key:__spreadArray([],__read(e.key),!1).reduce((function(n,r,t){return"".concat(n).concat(e.newlinePositions.includes(t)?"\n":"").concat(r)}),"")},n.prototype.getValueWithNewlines=function(e){return 0===e.newlinePositions.length||void 0===e.valuePosition?e.value:__spreadArray([],__read(e.value),!1).reduce((function(n,r,t){return"".concat(n).concat(e.newlinePositions.includes(t+e.valuePosition)?"\n":"").concat(r)}),"")},n.prototype.update=function(e,n){var r,t,i,o;this.parseLinesIfNeeded();var a=__spreadArray([],__read(this.collection),!1).reverse().find((function(n){return n.key===e}));if(!a||!n)return!1;var s=n.escapeUnicode||!1,c=n.separator?" "===n.separator?" ":" ".concat(n.separator," "):a.separator||" ".concat(DEFAULT_SEPARATOR," ").replace("  "," "),l=(null!==(r=n.newKey)&&void 0!==r?r:this.getKeyWithNewlines(a)).split(/\r?\n/).map((function(e){return escapeKey(e,s)})).join("\\\n"),p=(null!==(t=n.newValue)&&void 0!==t?t:this.getValueWithNewlines(a)).split(/\r?\n/).map((function(e){return escapeValue(e,s)})).join("\\\n"),d="".concat(n.commentDelimiter||DEFAULT_COMMENT_DELIMITER," "),u=void 0===n.newComment?"":"".concat("".concat(d).concat(n.newComment).split(/\r?\n/).join("\n".concat(d)),"\n"),_="".concat(u).concat(l).concat(c).concat(p).split(/\n/);return this.lines=__spreadArray(__spreadArray(__spreadArray([],__read(this.lines.slice(0,void 0===n.newComment?a.startingLineNumber-1:null!==(o=null===(i=a.previousProperty)||void 0===i?void 0:i.endingLineNumber)&&void 0!==o?o:0)),!1),__read(_),!1),__read(this.lines.slice(a.endingLineNumber)),!1),this.needsLineParsing=!0,!0},n.prototype.upsert=function(e,n,r){return this.parseLinesIfNeeded(),this.keyLineNumbers[e]?this.update(e,{newValue:n,newComment:null==r?void 0:r.comment,commentDelimiter:null==r?void 0:r.commentDelimiter,separator:null==r?void 0:r.separator,escapeUnicode:null==r?void 0:r.escapeUnicode}):this.insert(e,n,r)},n}(Properties);export{PropertiesEditor};

package/lib/esm/escape/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Escape a property key.
+ *
+ * @param unescapedKey - A property key to be escaped.
+ * @param escapeUnicode - Escape unicode characters into ISO-8859-1 compatible encoding?
+ *
+ * @returns The escaped key.
+ */
+export declare const escapeKey: (unescapedKey: string, escapeUnicode?: boolean) => string;
+/**
+ * Escape property value.
+ *
+ * @param unescapedValue - Property value to be escaped.
+ * @param escapeUnicode - Escape unicode characters into ISO-8859-1 compatible encoding?
+ *
+ * @returns The escaped value.
+ */
+export declare const escapeValue: (unescapedValue: string, escapeUnicode?: boolean) => string;

package/lib/esm/escape/index.js

@@ -0,0 +1 @@
+export var escapeKey=function(e,t){return void 0===t&&(t=!1),escapeContent(e,!0,t)};export var escapeValue=function(e,t){return void 0===t&&(t=!1),escapeContent(e,!1,t)};var escapeContent=function(e,t,n){return e.replace(new RegExp("[\\s!#:=\\\\".concat(n?"\\u0000-\\u001F\\u007F-\\uFFFF":"","]"),"g"),(function(e,n){switch(e){case" ":return t||0===n?"\\ ":" ";case"\\":return"\\\\";case"\f":return"\\f";case"\n":return"\\n";case"\r":return"\\r";case"\t":return"\\t";case"=":case":":case"#":case"!":return"\\".concat(e);default:return"\\u".concat(e.codePointAt(0).toString(16).padStart(4,"0"))}}))};

package/lib/esm/index.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="./properties-file" />
+/// <reference types="node" />
+export { Properties } from './properties';
+/**
+ * A key-value pair object.
+ */
+export type KeyValuePairObject = {
+    [key: string]: string;
+};
+/**
+ * Converts the content of a `.properties` file to a key-value pair object.
+ *
+ * @param content - The content of a `.properties` file.
+ *
+ * @returns A key/value object representing the content of a `.properties` file.
+ */
+export declare const getProperties: (content: string | Buffer) => KeyValuePairObject;

package/lib/esm/index.js

@@ -0,0 +1 @@
+import{Properties}from"./properties";export{Properties}from"./properties";export var getProperties=function(r){return new Properties(r).toObject()};

package/lib/esm/loader/webpack.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="../properties-file" />
+/**
+ * Webpack file loader for `.properties` files.
+ *
+ * @param content - the content of a `.properties` file.
+ *
+ * @returns A Webpack file loader string containing the content of  a `.properties` file.
+ */
+declare const webpackLoader: (content: string) => string;
+export default webpackLoader;

package/lib/esm/loader/webpack.js

@@ -0,0 +1 @@
+import{getProperties}from"..";var webpackLoader=function(e){return"module.exports = ".concat(JSON.stringify(getProperties(e)),";")};export default webpackLoader;

package/lib/esm/properties-file.d.ts

@@ -0,0 +1,7 @@
+/** This allows to get the correct type when using `import` on `.properties` files. */
+declare module '*.properties' {
+  const properties: {
+    readonly [key: string]: string
+  }
+  export default properties
+}

package/lib/esm/properties.d.ts

@@ -0,0 +1,95 @@
+/// <reference types="node" />
+import { KeyValuePairObject } from '.';
+import { Property } from './property';
+/**
+ * Byte-order mark.
+ */
+export declare const BOM = "\uFEFF";
+export declare const BOM_CODE_POINT: number | undefined;
+/** The default end of line character. */
+export declare const DEFAULT_END_OF_LINE_CHARACTER = "\n";
+/**
+ * Get the first end of line (EOL) character from multiline content.
+ *
+ * @param content - The content of a `.properties` file.
+ *
+ * @returns The multiline content's first end of line (EOL) character.
+ */
+export declare const getFirstEolCharacter: (content: string) => string | undefined;
+/**
+ * A class representing the content of a .properties file.
+ */
+export declare class Properties {
+    /** Does the .properties content starts with a BOM character? */
+    readonly hasBom: boolean;
+    /** The end of line character. */
+    readonly eolCharacter: string;
+    /** `.properties` content split by line. */
+    protected lines: string[];
+    /** The collection of property object. */
+    collection: Property[];
+    /** Object associating keys with their starting line numbers. */
+    keyLineNumbers: KeyLineNumbers;
+    /**
+     * Create `Properties` object.
+     *
+     * @param content - The content of a `.properties` file.
+     */
+    constructor(content: string | Buffer);
+    /**
+     * Parse the `.properties` content line by line.
+     */
+    protected parseLines(): void;
+    /**
+     * Add a property object into a properties object collection.
+     *
+     * @param property - A property object, or undefined.
+     *
+     * @returns Undefined so that we conveniently overwrite the property object.
+     */
+    private addToCollection;
+    /**
+     * Get keys that have collisions (more than one occurrence).
+     */
+    getKeyCollisions(): KeyCollisions[];
+    /**
+     * Get the key/value object representing the properties.
+     *
+     * @returns A key/value object representing the properties.
+     */
+    toObject(): KeyValuePairObject;
+    /**
+     * Format the object in `.properties`.
+     *
+     * @param endOfLineCharacter - The character used for end of lines.
+     *
+     * @returns The object in `.properties` format.
+     */
+    format(endOfLineCharacter?: '\n' | '\r\n'): string;
+}
+/**
+ * Object associating keys with their line numbers.
+ */
+export type KeyLineNumbers = {
+    [key: string]: number[];
+};
+/**
+ * A class representing key within a .properties file that had collisions (more than one occurrence).
+ */
+export declare class KeyCollisions {
+    /** The key with collisions. */
+    key: string;
+    /** The starting line numbers where collisions are found. */
+    startingLineNumbers: number[];
+    /**
+     * Create a new key collision object.
+     *
+     * @param key - The key with collisions.
+     * @param startingLineNumbers - The starting line numbers where collisions are found.
+     */
+    constructor(key: string, startingLineNumbers: number[]);
+    /**
+     * Get the number of the line from which the value will be used.
+     */
+    getApplicableLineNumber(): number | undefined;
+}

package/lib/esm/properties.js

@@ -0,0 +1 @@
+var __values=this&&this.__values||function(e){var t="function"==typeof Symbol&&Symbol.iterator,r=t&&e[t],n=0;if(r)return r.call(e);if(e&&"number"==typeof e.length)return{next:function(){return e&&n>=e.length&&(e=void 0),{value:e&&e[n++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")},__read=this&&this.__read||function(e,t){var r="function"==typeof Symbol&&e[Symbol.iterator];if(!r)return e;var n,i,o=r.call(e),s=[];try{for(;(void 0===t||t-- >0)&&!(n=o.next()).done;)s.push(n.value)}catch(e){i={error:e}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(i)throw i.error}}return s};import{Property}from"./property";import{PropertyLine}from"./property-line";export var BOM="\ufeff";export var BOM_CODE_POINT=BOM.codePointAt(0);export var DEFAULT_END_OF_LINE_CHARACTER="\n";export var getFirstEolCharacter=function(e){var t=e.indexOf("\n");return t<0?void 0:"".concat("\r"===e[t-1]?"\r":"","\n")};var Properties=function(){function e(e){var t;this.collection=[],this.keyLineNumbers={};var r="string"==typeof e?e:e.toString();this.hasBom=r.codePointAt(0)===BOM_CODE_POINT,this.eolCharacter=null!==(t=getFirstEolCharacter(r))&&void 0!==t?t:DEFAULT_END_OF_LINE_CHARACTER,this.lines=(this.hasBom?r.slice(1):r).split(/\r?\n/),this.parseLines()}return e.prototype.parseLines=function(){var e,t;this.collection=[],this.keyLineNumbers={};var r,n,i=0;try{for(var o=__values(this.lines),s=o.next();!s.done;s=o.next()){var l=s.value;i++;var a=new PropertyLine(l,!!r);if(r){if(r.addLine(a),a.isContinuing)continue}else{if(a.isComment||a.isBlank)continue;if(r=new Property(a,i,n),a.isContinuing)continue}this.addToCollection(r),n=r,r=void 0}}catch(t){e={error:t}}finally{try{s&&!s.done&&(t=o.return)&&t.call(o)}finally{if(e)throw e.error}}},e.prototype.addToCollection=function(e){var t;e.setKeyAndValue(),(null===(t=this.keyLineNumbers[e.key])||void 0===t?void 0:t.length)?(this.keyLineNumbers[e.key].push(e.startingLineNumber),e.hasKeyCollisions=!0,e.keyCollisionLines=this.keyLineNumbers[e.key],this.collection=this.collection.filter((function(t){return t.key!==e.key}))):this.keyLineNumbers[e.key]=[e.startingLineNumber],this.collection.push(e)},e.prototype.getKeyCollisions=function(){var e,t,r=[];try{for(var n=__values(Object.entries(this.keyLineNumbers)),i=n.next();!i.done;i=n.next()){var o=__read(i.value,2),s=o[0],l=o[1];l.length>1&&r.push(new KeyCollisions(s,l))}}catch(t){e={error:t}}finally{try{i&&!i.done&&(t=n.return)&&t.call(n)}finally{if(e)throw e.error}}return r},e.prototype.toObject=function(){var e={};return this.collection.forEach((function(t){e[t.key]=t.value})),e},e.prototype.format=function(e){return"".concat(this.hasBom?BOM:"").concat(this.lines.join(e||this.eolCharacter))},e}();export{Properties};var KeyCollisions=function(){function e(e,t){this.key=e,this.startingLineNumbers=t}return e.prototype.getApplicableLineNumber=function(){return this.startingLineNumbers.slice(-1)[0]},e}();export{KeyCollisions};

package/lib/esm/property-line.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Object representing a line from the content of .properties file.
+ */
+export declare class PropertyLine {
+    /** The line content, minus the trailing `\` that identifies that the line is continuing. */
+    content: string;
+    /** True if the line is continuing to the next line, otherwise false. */
+    isContinuing: boolean;
+    /** True if the line is blank, otherwise false. */
+    isBlank: boolean;
+    /** True if the line is a comment, otherwise false. */
+    isComment: boolean;
+    /** Is the line object a continuation from a previous line? */
+    isMultiline: boolean;
+    /**
+     * Create a new line object.
+     *
+     * @param line - The raw content of a line.
+     * @param isMultiline - Is the line spreading on multiple lines?
+     */
+    constructor(line: string, isMultiline: boolean);
+}

package/lib/esm/property-line.js

@@ -0,0 +1 @@
+var PropertyLine=function(t,i){if(this.isContinuing=!1,this.isBlank=!1,this.isComment=!1,this.content=t.trimStart(),this.isMultiline=i,0===this.content.length)this.isBlank=!0;else if(this.isMultiline||(this.isComment=!!/^[!#]/.test(this.content)),!this.isComment){var s=this.content.match(/(?<backslashes>\\+)$/);(null==s?void 0:s.groups)&&(this.isContinuing=!!(s.groups.backslashes.length%2),this.isContinuing&&(this.content=this.content.slice(0,-1)))}};export{PropertyLine};

package/lib/esm/property.d.ts

@@ -0,0 +1,83 @@
+import { PropertyLine } from './property-line';
+/**
+ * Object representing a property (key/value).
+ */
+export declare class Property {
+    /** The content of one or multiple lines when applicable. */
+    linesContent: string;
+    /** The property key (unescaped). */
+    key: string;
+    /** The property key, including its escaped characters. */
+    escapedKey: string;
+    /** Is the key empty? */
+    private hasNoKey;
+    /** Does the key definition spread across multiple lines? */
+    private hasMultilineKey;
+    /** Starting line numbers of property objects with the same key. */
+    keyCollisionLines: number[];
+    /** Was the property's key used more than once? */
+    hasKeyCollisions: boolean;
+    /** The key/value pair separator */
+    separator: string | undefined;
+    /** The length of the key/value pair separator, including its whitespace characters. */
+    separatorLength: number | undefined;
+    /** The starting position of the key/value pair separator. */
+    separatorPosition: number | undefined;
+    /** The property value (unescaped). */
+    value: string;
+    /** The starting position of the value. */
+    valuePosition: number | undefined;
+    /** The property value, including its escaped characters. */
+    escapedValue: string;
+    /** Is the value empty? */
+    private hasNoValue;
+    /** Positions of the newline characters if any. */
+    newlinePositions: number[];
+    /** The line number at which the property starts. */
+    readonly startingLineNumber: number;
+    /** The line number at which the property ends. */
+    endingLineNumber: number;
+    /** The previous property object if it exists. */
+    readonly previousProperty?: Property;
+    /** The next property object if it exists. */
+    nextProperty?: Property;
+    /**
+     * Create a new property object.
+     *
+     * @param propertyLine - A property line object.
+     * @param startingLineNumber - The line number at which the property starts.
+     */
+    constructor(propertyLine: PropertyLine, startingLineNumber: number, previousProperty?: Property);
+    /**
+     * Set the next property object.
+     *
+     * @param property - The next property object
+     */
+    setNextProperty(property: Property): void;
+    /**
+     * Add the a line to a multiline property object.
+     *
+     * @param propertyLine - A property line object.
+     */
+    addLine(propertyLine: PropertyLine): void;
+    /**
+     * Set the property's key and value.
+     */
+    setKeyAndValue(): void;
+    /**
+     * Unescape the content from either key or value of a property.
+     *
+     * @param escapedContent - The content to unescape.
+     * @param startingLineNumber - The starting line number of the content being unescaped.
+     *
+     * @returns The unescaped content.
+     *
+     * @throws {@link Error}
+     * This exception is thrown if malformed escaped unicode characters are present.
+     */
+    private unescapeLine;
+    /**
+     * Find the character separating the key from the value.
+     */
+    private findSeparator;
+}

package/lib/esm/property.js

@@ -0,0 +1 @@
+var __values=this&&this.__values||function(t){var e="function"==typeof Symbol&&Symbol.iterator,i=e&&t[e],s=0;if(i)return i.call(t);if(t&&"number"==typeof t.length)return{next:function(){return t&&s>=t.length&&(t=void 0),{value:t&&t[s++],done:!t}}};throw new TypeError(e?"Object is not iterable.":"Symbol.iterator is not defined.")};import{unescapeContent}from"./unescape";var Property=function(){function t(t,e,i){this.key="",this.escapedKey="",this.hasNoKey=!1,this.hasMultilineKey=!1,this.keyCollisionLines=[],this.hasKeyCollisions=!1,this.value="",this.escapedValue="",this.hasNoValue=!1,this.newlinePositions=[],this.linesContent=t.content,this.startingLineNumber=e,this.endingLineNumber=e,this.previousProperty=i,null==i||i.setNextProperty(this)}return t.prototype.setNextProperty=function(t){this.nextProperty=t},t.prototype.addLine=function(t){this.linesContent.length>0&&(this.newlinePositions.push(this.linesContent.length),this.endingLineNumber++),this.linesContent+=t.content},t.prototype.setKeyAndValue=function(){this.findSeparator(),void 0!==this.separatorPosition&&void 0!==this.separatorLength?(this.hasNoKey||(this.escapedKey=this.linesContent.slice(0,this.separatorPosition),this.key=this.unescapeLine(this.escapedKey,this.startingLineNumber)),this.hasNoValue||(this.escapedValue=this.linesContent.slice(this.separatorPosition+this.separatorLength),this.value=this.unescapeLine(this.escapedValue,this.startingLineNumber))):this.hasNoValue&&(this.escapedKey=this.linesContent,this.key=this.unescapeLine(this.escapedKey,this.startingLineNumber))},t.prototype.unescapeLine=function(t,e){try{return unescapeContent(t)}catch(t){throw new Error("".concat(t.message," in property starting at line ").concat(e))}},t.prototype.findSeparator=function(){var t,e,i,s;if(!(this.hasNoKey||this.hasNoValue||this.separatorPosition)){try{for(var n=__values(this.linesContent.matchAll(/[\t\f :=]/g)),o=n.next();!o.done;o=n.next()){var r=o.value.index,a=this.linesContent.slice(0,r).match(/(?<backslashes>\\+)$/);if(null==a?void 0:a.groups)if(!!(a.groups.backslashes.length%2))continue;var h="";this.separatorPosition=r;var l=this.linesContent.slice(r),p=l.match(/^(?<whitespace>[\t\n\v\f\r ]+)/),u=(null===(i=null==p?void 0:p.groups)||void 0===i?void 0:i.whitespace)||"";if(u.length>0&&(h+=u,l=l.slice(u.length)),/[:=]/.test(l[0])){h+=l[0];var c=(l=l.slice(1)).match(/^(?<whitespace>[\t\n\v\f\r ]+)/);h+=(null===(s=null==c?void 0:c.groups)||void 0===s?void 0:s.whitespace)||""}this.separatorLength=h.length,this.valuePosition=this.separatorPosition+this.separatorLength,this.separator=this.linesContent.slice(this.separatorPosition,this.separatorPosition+this.separatorLength),r||(this.hasNoKey=!0);break}}catch(e){t={error:e}}finally{try{o&&!o.done&&(e=n.return)&&e.call(n)}finally{if(t)throw t.error}}void 0===this.separatorPosition?this.hasNoValue=!0:this.newlinePositions.length>0&&this.newlinePositions[0]<this.separatorPosition&&(this.hasMultilineKey=!0)}},t}();export{Property};

package/lib/esm/unescape/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Unescape the content from either key or value of a property.
+ *
+ * @param escapedContent - The content to unescape.
+ *
+ * @returns The unescaped content.
+ *
+ * @throws {@link Error}
+ * This exception is thrown if malformed escaped unicode characters are present.
+ */
+export declare const unescapeContent: (escapedContent: string) => string;

package/lib/esm/unescape/index.js

@@ -0,0 +1 @@
+export var unescapeContent=function(r){return r.replace(/\\[^u]|\\u.{4}/g,(function(r){var e=r.charAt(1);switch(e){case"f":return"\f";case"n":return"\n";case"r":return"\r";case"t":return"\t";case"u":var t=r.slice(2,6);if(!/[\da-f]{4}/i.test(t))throw new Error("malformed escaped unicode characters '\\u".concat(t,"'"));return String.fromCodePoint(Number.parseInt(t,16));default:return e}}))};