@jahia/javascript-modules-library 0.2.0 → 0.4.0

package/types/java.util.d.ts

@@ -84,11 +84,11 @@ export class Collection<E> {
  * global positioning system (GPS) is synchronized to UTC but is
  * not adjusted for leap seconds. An interesting source of
  * further information is the United States Naval Observatory (USNO):
- *  *     http://www.usno.navy.mil/USNO
+ *  *     https://www.usno.navy.mil/USNO
  * 
  * 
  * and the material regarding "Systems of Time" at:
- *  *     http://www.usno.navy.mil/USNO/time/master-clock/systems-of-time
+ *  *     https://www.usno.navy.mil/USNO/time/master-clock/systems-of-time
  * 
  * 
  * which has descriptions of various different time systems including
@@ -183,7 +183,6 @@ export class Date {
  * NOTE: This class is obsolete.  New implementations should
  * implement the Map interface, rather than extending this class.
  *
- * @author  unascribed
  * @see     java.util.Map
  * @see     java.lang.Object#equals(java.lang.Object)
  * @see     java.lang.Object#hashCode()
@@ -216,7 +215,7 @@ export class Dictionary<K, V> {
    * @param   key   a key in this dictionary.
    *          `null` if the key is not mapped to any value in
    *          this dictionary.
-   * @exception NullPointerException if the `key` is `null`.
+   * @throws    NullPointerException if the `key` is `null`.
    * @see     java.util.Dictionary#put(java.lang.Object, java.lang.Object)
   */
   get(key: any): V;
@@ -270,7 +269,7 @@ export class Enumeration<E> {
    * object has at least one more element to provide.
    *
    * @return     the next element of this enumeration.
-   * @exception  NoSuchElementException  if no more elements exist.
+   * @throws     NoSuchElementException  if no more elements exist.
   */
   nextElement(): E;
 }
@@ -351,9 +350,9 @@ export class List<E> {
   get(index: number): E;
 }
 /**
- * A Locale object represents a specific geographical, political,
- * or cultural region. An operation that requires a Locale to perform
- * its task is called locale-sensitive and uses the Locale
+ * A `Locale` object represents a specific geographical, political,
+ * or cultural region. An operation that requires a `Locale` to perform
+ * its task is called locale-sensitive and uses the `Locale`
  * to tailor information for the user. For example, displaying a number
  * is a locale-sensitive operation— the number should be formatted
  * according to the customs and conventions of the user's native country,
@@ -366,7 +365,7 @@ export class List<E> {
  * Locale Data Markup Language") BCP 47-compatible extensions for locale data
  * exchange.
  *
- *  A Locale object logically consists of the fields
+ *  A `Locale` object logically consists of the fields
  * described below.
  *
  * 
@@ -378,7 +377,7 @@ export class List<E> {
  *   alpha-2 code must be used.  You can find a full list of valid
  *   language codes in the IANA Language Subtag Registry (search for
  *   "Type: language").  The language field is case insensitive, but
- *   Locale always canonicalizes to lower case.
+ *   `Locale` always canonicalizes to lower case.
  *
  *   Well-formed language values have the form
  *   [a-zA-Z]{2,8}.  Note that this is not the full
@@ -393,7 +392,7 @@ export class List<E> {
  *   ISO 15924 alpha-4 script code.  You can find a full list of
  *   valid script codes in the IANA Language Subtag Registry (search
  *   for "Type: script").  The script field is case insensitive, but
- *   Locale always canonicalizes to title case (the first
+ *   `Locale` always canonicalizes to title case (the first
  *   letter is upper case and the rest of the letters are lower
  *   case).
  *
@@ -408,7 +407,7 @@ export class List<E> {
  *   You can find a full list of valid country and region codes in the
  *   IANA Language Subtag Registry (search for "Type: region").  The
  *   country (region) field is case insensitive, but
- *   Locale always canonicalizes to upper case.
+ *   `Locale` always canonicalizes to upper case.
  *
  *   Well-formed country/region values have
  *   the form [a-zA-Z]{2} | [0-9]{3}
@@ -419,7 +418,7 @@ export class List<E> {
  *   variant
  *
  *   Any arbitrary value used to indicate a variation of a
- *   Locale.  Where there are two or more variant values
+ *   `Locale`.  Where there are two or more variant values
  *   each indicating its own semantics, these values should be ordered
  *   by importance, with most important first, separated by
  *   underscore('_').  The variant field is case sensitive.
@@ -431,7 +430,7 @@ export class List<E> {
  *   region subtags.  You can find a full list of valid variant codes
  *   in the IANA Language Subtag Registry (search for "Type: variant").
  *
- *   However, the variant field in Locale has
+ *   However, the variant field in `Locale` has
  *   historically been used for any kind of variation, not just
  *   language variations.  For example, some supported variants
  *   available in Java SE Runtime Environments indicate alternative
@@ -451,15 +450,15 @@ export class List<E> {
  *
  *   A map from single character keys to string values, indicating
  *   extensions apart from language identification.  The extensions in
- *   Locale implement the semantics and syntax of BCP 47
+ *   `Locale` implement the semantics and syntax of BCP 47
  *   extension subtags and private use subtags. The extensions are
- *   case insensitive, but Locale canonicalizes all
+ *   case insensitive, but `Locale` canonicalizes all
  *   extension keys and values to lower case. Note that extensions
  *   cannot have empty values.
  *
  *   Well-formed keys are single characters from the set
- *   [0-9a-zA-Z].  Well-formed values have the form
- *   SUBTAG ('-' SUBTAG)* where for the key 'x'
+ *   `[0-9a-zA-Z]`.  Well-formed values have the form
+ *   `SUBTAG ('-' SUBTAG)*` where for the key 'x'
  *   SUBTAG = [0-9a-zA-Z]{1,8} and for other keys
  *   SUBTAG = [0-9a-zA-Z]{2,8} (that is, 'x' allows
  *   single-character subtags).
@@ -469,8 +468,8 @@ export class List<E> {
  * 
  *
  * Note: Although BCP 47 requires field values to be registered
- * in the IANA Language Subtag Registry, the Locale class
- * does not provide any validation features.  The Builder
+ * in the IANA Language Subtag Registry, the `Locale` class
+ * does not provide any validation features.  The `Builder`
  * only checks if an individual field satisfies the syntactic
  * requirement (is well-formed), but does not validate the value
  * itself.  See {@link Builder} for details.
@@ -488,11 +487,11 @@ export class List<E> {
  * extension key 'u' ({@link #UNICODE_LOCALE_EXTENSION}).  The above
  * example, "nu-thai", becomes the extension "u-nu-thai".
  *
- * Thus, when a Locale object contains Unicode locale
+ * Thus, when a `Locale` object contains Unicode locale
  * attributes and keywords,
- * getExtension(UNICODE_LOCALE_EXTENSION) will return a
+ * `getExtension(UNICODE_LOCALE_EXTENSION)` will return a
  * String representing this information, for example, "nu-thai".  The
- * Locale class also provides {@link
+ * `Locale` class also provides {@link
  * #getUnicodeLocaleAttributes}, {@link #getUnicodeLocaleKeys}, and
  * {@link #getUnicodeLocaleType} which allow you to access Unicode
  * locale attributes and key/type pairs directly.  When represented as
@@ -517,37 +516,37 @@ export class List<E> {
  *
  * Creating a Locale
  *
- * There are several different ways to create a Locale
+ * There are several different ways to create a `Locale`
  * object.
  *
  * Builder
  *
- * Using {@link Builder} you can construct a Locale object
+ * Using {@link Builder} you can construct a `Locale` object
  * that conforms to BCP 47 syntax.
  *
  * Constructors
  *
- * The Locale class provides three constructors:
+ * The `Locale` class provides three constructors:
  * 
  *  *     {@link #Locale(String language)}
  *     {@link #Locale(String language, String country)}
  *     {@link #Locale(String language, String country, String variant)}
  * 
  * 
- * These constructors allow you to create a Locale object
+ * These constructors allow you to create a `Locale` object
  * with language, country and variant, but you cannot specify
  * script or extensions.
  *
  * Factory Methods
  *
- * The method {@link #forLanguageTag} creates a Locale
+ * The method {@link #forLanguageTag} creates a `Locale`
  * object for a well-formed BCP 47 language tag.
  *
  * Locale Constants
  *
- * The Locale class provides a number of convenient constants
- * that you can use to create Locale objects for commonly used
- * locales. For example, the following creates a Locale object
+ * The `Locale` class provides a number of convenient constants
+ * that you can use to create `Locale` objects for commonly used
+ * locales. For example, the following creates a `Locale` object
  * for the United States:
  * 
  *  *     Locale.US
@@ -626,25 +625,25 @@ export class List<E> {
  *
  * Use of Locale
  *
- * Once you've created a Locale you can query it for information
- * about itself. Use getCountry to get the country (or region)
- * code and getLanguage to get the language code.
- * You can use getDisplayCountry to get the
+ * Once you've created a `Locale` you can query it for information
+ * about itself. Use `getCountry` to get the country (or region)
+ * code and `getLanguage` to get the language code.
+ * You can use `getDisplayCountry` to get the
  * name of the country suitable for displaying to the user. Similarly,
- * you can use getDisplayLanguage to get the name of
+ * you can use `getDisplayLanguage` to get the name of
  * the language suitable for displaying to the user. Interestingly,
- * the getDisplayXXX methods are themselves locale-sensitive
+ * the `getDisplayXXX` methods are themselves locale-sensitive
  * and have two versions: one that uses the default
  * {@link Locale.Category#DISPLAY DISPLAY} locale and one
  * that uses the locale specified as an argument.
  *
  * The Java Platform provides a number of classes that perform locale-sensitive
- * operations. For example, the NumberFormat class formats
+ * operations. For example, the `NumberFormat` class formats
  * numbers, currency, and percentages in a locale-sensitive manner. Classes
- * such as NumberFormat have several convenience methods
+ * such as `NumberFormat` have several convenience methods
  * for creating a default object of that type. For example, the
- * NumberFormat class provides these three convenience methods
- * for creating a default NumberFormat object:
+ * `NumberFormat` class provides these three convenience methods
+ * for creating a default `NumberFormat` object:
  * 
  *  *     NumberFormat.getInstance()
  *     NumberFormat.getCurrencyInstance()
@@ -660,8 +659,8 @@ export class List<E> {
  *     NumberFormat.getPercentInstance(myLocale)
  * 
  * 
- * A Locale is the mechanism for identifying the kind of object
- * (NumberFormat) that you would like to get. The locale is
+ * A `Locale` is the mechanism for identifying the kind of object
+ * (`NumberFormat`) that you would like to get. The locale is
  * just a mechanism for identifying objects,
  * not a container for the objects themselves.
  *
@@ -670,7 +669,7 @@ export class List<E> {
  * In order to maintain compatibility with existing usage, Locale's
  * constructors retain their behavior prior to the Java Runtime
  * Environment version 1.7.  The same is largely true for the
- * toString method. Thus Locale objects can continue to
+ * `toString` method. Thus Locale objects can continue to
  * be used as they were. In particular, clients who parse the output
  * of toString into language, country, and variant fields can continue
  * to do so (although this is strongly discouraged), although the
@@ -680,15 +679,15 @@ export class List<E> {
  * In addition, BCP 47 imposes syntax restrictions that are not
  * imposed by Locale's constructors. This means that conversions
  * between some Locales and BCP 47 language tags cannot be made without
- * losing information. Thus toLanguageTag cannot
+ * losing information. Thus `toLanguageTag` cannot
  * represent the state of locales whose language, country, or variant
  * do not conform to BCP 47.
  *
  * Because of these issues, it is recommended that clients migrate
  * away from constructing non-conforming locales and use the
- * forLanguageTag and Locale.Builder APIs instead.
+ * `forLanguageTag` and `Locale.Builder` APIs instead.
  * Clients desiring a string representation of the complete locale can
- * then always rely on toLanguageTag for this purpose.
+ * then always rely on `toLanguageTag` for this purpose.
  *
  * Special cases
  *
@@ -729,14 +728,24 @@ export class List<E> {
  * Locale's constructor has always converted three language codes to
  * their earlier, obsoleted forms: `he` maps to `iw`,
  * `yi` maps to `ji`, and `id` maps to
- * `in`.  This continues to be the case, in order to not break
- * backwards compatibility.
+ * `in`. Since Java SE 17, this is no longer the case. Each
+ * language maps to its new form; `iw` maps to `he`, `ji`
+ * maps to `yi`, and `in` maps to `id`.
+ *
+ * For the backward compatible behavior, the system property
+ * {@systemProperty java.locale.useOldISOCodes} reverts the behavior
+ * back to that of before Java SE 17. If the system property is set to
+ * `true`, those three current language codes are mapped to their
+ * backward compatible forms. The property is only read at Java runtime
+ * startup and subsequent calls to `System.setProperty()` will
+ * have no effect.
  *
  * The APIs added in 1.7 map between the old and new language codes,
- * maintaining the old codes internal to Locale (so that
- * getLanguage and toString reflect the old
- * code), but using the new codes in the BCP 47 language tag APIs (so
- * that toLanguageTag reflects the new one). This
+ * maintaining the mapped codes internal to Locale (so that
+ * `getLanguage` and `toString` reflect the mapped
+ * code, which depends on the `java.locale.useOldISOCodes` system
+ * property), but using the new codes in the BCP 47 language tag APIs (so
+ * that `toLanguageTag` reflects the new one). This
  * preserves the equivalence between Locales no matter which code or
  * API is used to construct them. Java's default resource bundle
  * lookup mechanism also implements this mapping, so that resources
@@ -781,7 +790,7 @@ export class Locale {
    * The returned array represents the union of locales supported
    * by the Java runtime environment and by installed
    * {@link java.util.spi.LocaleServiceProvider LocaleServiceProvider}
-   * implementations.  It must contain at least a Locale
+   * implementations.  It must contain at least a `Locale`
    * instance equal to {@link java.util.Locale#US Locale.US}.
    *
    * @return An array of installed locales.
@@ -793,7 +802,7 @@ export class Locale {
    * This method is equivalent to {@link #getISOCountries(Locale.IsoCountryCode type)}
    * with `type`  {@link IsoCountryCode#PART1_ALPHA2}.
    * 
-   * Note: The Locale class also supports other codes for
+   * Note: The `Locale` class also supports other codes for
    * country (region), such as 3-letter numeric UN M.49 area codes.
    * Therefore, the list returned by this method does not contain ALL valid
    * codes that can be used to create Locales.
@@ -814,7 +823,7 @@ export class Locale {
    * ISO 639 is not a stable standard— some languages' codes have changed.
    * The list this function returns includes both the new and the old codes for the
    * languages whose codes have changed.
-   * The Locale class also supports language codes up to
+   * The `Locale` class also supports language codes up to
    * 8 characters in length.  Therefore, the list returned by this method does
    * not contain ALL valid codes that can be used to create Locales.
    * 
@@ -825,17 +834,10 @@ export class Locale {
   /**
    * Returns the language code of this Locale.
    *
-   * Note: ISO 639 is not a stable standard— some languages' codes have changed.
-   * Locale's constructor recognizes both the new and the old codes for the languages
-   * whose codes have changed, but this function always returns the old code.  If you
-   * want to check for a specific language whose code has changed, don't do
-   *      * if (locale.getLanguage().equals("he")) // BAD!
-   *    ...
-   * 
-   * Instead, do
-   *      * if (locale.getLanguage().equals(new Locale("he").getLanguage()))
-   *    ...
-   * 
+   * @implNote This method returns the new forms for the obsolete ISO 639
+   * codes ("iw", "ji", and "in"). See 
+   * Legacy language codes for more information.
+   *
    * @return The language code, or the empty string if none is defined.
    * @see #getDisplayLanguage
   */
@@ -871,7 +873,7 @@ export class Locale {
    * Returns the extension (or private use) value associated with
    * the specified key, or null if there is no extension
    * associated with the key. To be well-formed, the key must be one
-   * of [0-9A-Za-z]. Keys are case-insensitive, so
+   * of `[0-9A-Za-z]`. Keys are case-insensitive, so
    * for example 'z' and 'Z' represent the same extension.
    *
    * @param key the extension key
@@ -913,7 +915,7 @@ export class Locale {
    * @return The Unicode locale type associated with the key, or null if the
    * locale does not define the key.
    * @throws IllegalArgumentException if the key is not well-formed
-   * @throws NullPointerException if key is null
+   * @throws NullPointerException if `key` is null
    * @since 1.7
   */
   getUnicodeLocaleType(key: string): string;
@@ -927,7 +929,7 @@ export class Locale {
   */
   getUnicodeLocaleKeys(): Set<string>;
   /**
-   * Returns a string representation of this Locale
+   * Returns a string representation of this `Locale`
    * object, consisting of language, country, variant, script,
    * and extensions as below:
    * 
@@ -950,7 +952,7 @@ export class Locale {
    * added before the "#".
    *
    * This behavior is designed to support debugging and to be compatible with
-   * previous uses of toString that expected language, country, and variant
+   * previous uses of `toString` that expected language, country, and variant
    * fields only.  To represent a Locale as a String for interchange purposes, use
    * {@link #toLanguageTag}.
    *
@@ -980,7 +982,7 @@ export class Locale {
    * not specify a language the empty string is returned.
    *
    * @return A three-letter abbreviation of this locale's language.
-   * @exception MissingResourceException Throws MissingResourceException if
+   * @throws    MissingResourceException Throws MissingResourceException if
    * three-letter language abbreviation is not available for this locale.
   */
   getISO3Language(): string;
@@ -994,7 +996,7 @@ export class Locale {
    * The ISO 3166-1 codes can be found on-line.
    *
    * @return A three-letter abbreviation of this locale's country.
-   * @exception MissingResourceException Throws MissingResourceException if the
+   * @throws    MissingResourceException Throws MissingResourceException if the
    * three-letter country abbreviation is not available for this locale.
   */
   getISO3Country(): string;
@@ -1032,7 +1034,7 @@ export class Locale {
    *
    * @param inLocale The locale for which to retrieve the display language.
    * @return The name of the display language appropriate to the given locale.
-   * @exception NullPointerException if inLocale is null
+   * @throws    NullPointerException if `inLocale` is `null`
   */
   getDisplayLanguage(inLocale: Locale): string;
   /**
@@ -1055,7 +1057,7 @@ export class Locale {
    * @param inLocale The locale for which to retrieve the display script.
    * @return the display name of the script code for the current default
    * {@link Locale.Category#DISPLAY DISPLAY} locale
-   * @throws NullPointerException if inLocale is null
+   * @throws NullPointerException if `inLocale` is `null`
    * @since 1.7
   */
   getDisplayScript(inLocale: Locale): string;
@@ -1093,7 +1095,7 @@ export class Locale {
    *
    * @param inLocale The locale for which to retrieve the display country.
    * @return The name of the country appropriate to the given locale.
-   * @exception NullPointerException if inLocale is null
+   * @throws    NullPointerException if `inLocale` is `null`
   */
   getDisplayCountry(inLocale: Locale): string;
   /**
@@ -1112,7 +1114,7 @@ export class Locale {
    *
    * @param inLocale The locale for which to retrieve the display variant code.
    * @return The name of the display variant code appropriate to the given locale.
-   * @exception NullPointerException if inLocale is null
+   * @throws    NullPointerException if `inLocale` is `null`
   */
   getDisplayVariant(inLocale: Locale): string;
   /**
@@ -1159,7 +1161,7 @@ export class Locale {
    *
    * @param inLocale The locale for which to retrieve the display name.
    * @return The name of the locale appropriate to display.
-   * @throws NullPointerException if inLocale is null
+   * @throws NullPointerException if `inLocale` is `null`
   */
   getDisplayName(inLocale: Locale): string;
 }
@@ -1264,10 +1266,12 @@ export class Locale {
  * passed to a static factory method result in `IllegalArgumentException`.
  * The iteration order of mappings is unspecified and is subject to change.
  * They are value-based.
- * Callers should make no assumptions about the identity of the returned instances.
- * Factories are free to create new instances or reuse existing ones. Therefore,
- * identity-sensitive operations on these instances (reference equality (`==`),
- * identity hash code, and synchronization) are unreliable and should be avoided.
+ * Programmers should treat instances that are {@linkplain #equals(Object) equal}
+ * as interchangeable and should not use them for synchronization, or
+ * unpredictable behavior may occur. For example, in a future release,
+ * synchronization may fail. Callers should make no assumptions
+ * about the identity of the returned instances. Factories are free to
+ * create new instances or reuse existing ones.
  * They are serialized as specified on the
  * Serialized Form
  * page.
@@ -1423,7 +1427,7 @@ export class Map<K, V> {
    * `null`, else returns the current value.
    *
    * @implSpec
-   * The default implementation is equivalent to, for this `     * map`:
+   * The default implementation is equivalent to, for this `map`:
    *
    *  {@code
    * V v = map.get(key);

package/core/index.js

@@ -1 +0,0 @@
-export*from"./server";

package/core/server/components/index.js

@@ -1 +0,0 @@
-export*from"./AddContentButtons";export*from"./AddResources";export*from"./Area";export*from"./AbsoluteArea";export*from"./render";

package/core/server/components/render/index.js

@@ -1 +0,0 @@
-export*from"./Render";export*from"./HydrateInBrowser";export*from"./RenderInBrowser";

package/core/server/framework/index.js

@@ -1 +0,0 @@
-export*from"./register";export*from"./defineJahiaComponent";

package/core/server/hooks/index.js

@@ -1 +0,0 @@
-export*from"./useGQLQuery";export*from"./useJCRQuery";export*from"./useServerContext";export*from"./useUrlBuilder";

package/core/server/index.js

@@ -1 +0,0 @@
-export*from"./components";export*from"./framework";export*from"./hooks";export*from"./utils";

package/core/server/utils/index.js

@@ -1 +0,0 @@
-export*from"./jcr";export*from"./urlBuilder";

package/core/server/utils/jcr/index.js

@@ -1 +0,0 @@
-export*from"./getChildNodes";export*from"./getNodeFromPathOrId";export*from"./getNodeProps";export*from"./getNodesByJCRQuery";

package/core/server/utils/urlBuilder/index.js

@@ -1 +0,0 @@
-export*from"./urlBuilder";

package/nav/index.js

@@ -1 +0,0 @@
-export*from"./server";

package/nav/server/index.js

@@ -1 +0,0 @@
-export*from"./navBuilder";

package/nav/server/navBuilder/index.js

@@ -1 +0,0 @@
-export*from"./navBuilder";

package/types/core/index.d.ts

@@ -1 +0,0 @@
-export * from "./server";

package/types/core/server/components/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./AddContentButtons";
-export * from "./AddResources";
-export * from "./Area";
-export * from "./AbsoluteArea";
-export * from "./render";

package/types/core/server/components/render/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./Render";
-export * from "./HydrateInBrowser";
-export * from "./RenderInBrowser";

package/types/core/server/framework/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./register";
-export * from "./defineJahiaComponent";

package/types/core/server/hooks/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./useGQLQuery";
-export * from "./useJCRQuery";
-export * from "./useServerContext";
-export * from "./useUrlBuilder";

package/types/core/server/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./components";
-export * from "./framework";
-export * from "./hooks";
-export * from "./utils";

package/types/core/server/utils/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./jcr";
-export * from "./urlBuilder";

package/types/core/server/utils/jcr/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./getChildNodes";
-export * from "./getNodeFromPathOrId";
-export * from "./getNodeProps";
-export * from "./getNodesByJCRQuery";

package/types/core/server/utils/urlBuilder/index.d.ts

@@ -1 +0,0 @@
-export * from "./urlBuilder";

package/types/nav/index.d.ts

@@ -1 +0,0 @@
-export * from "./server";

package/types/nav/server/index.d.ts

@@ -1 +0,0 @@
-export * from "./navBuilder";

package/types/nav/server/navBuilder/index.d.ts

@@ -1 +0,0 @@
-export * from "./navBuilder";