ol 9.0.0-dev.1706533843703 → 9.0.0-dev.1706603894900

package/format/GPX.d.ts

@@ -1,4 +1,76 @@
 export default GPX;
+export type GPXLink = {
+    /**
+     * text
+     */
+    text?: string | undefined;
+    /**
+     * type
+     */
+    type?: string | undefined;
+};
+export type GPXAuthor = {
+    /**
+     * name
+     */
+    name?: string | undefined;
+    /**
+     * email
+     */
+    email?: string | undefined;
+    /**
+     * link
+     */
+    link?: GPXLink | undefined;
+};
+export type GPXMetadata = {
+    /**
+     * name
+     */
+    name?: string | undefined;
+    /**
+     * desc
+     */
+    desc?: string | undefined;
+    /**
+     * author
+     */
+    author?: GPXAuthor | undefined;
+    /**
+     * link
+     */
+    link?: GPXLink | undefined;
+    /**
+     * time
+     */
+    time?: number | undefined;
+    /**
+     * keywords
+     */
+    keywords?: string | undefined;
+    /**
+     * bounds
+     */
+    bounds?: number[] | undefined;
+    /**
+     * extensions
+     */
+    extensions?: any;
+};
+export type GPXCopyright = {
+    /**
+     * author
+     */
+    author?: string | undefined;
+    /**
+     * year
+     */
+    year?: number | undefined;
+    /**
+     * license
+     */
+    license?: string | undefined;
+};
 export type Options = {
     /**
      * Callback function
@@ -65,6 +137,29 @@ declare class GPX extends XMLFeature {
      * @private
      */
     private handleReadExtensions_;
+    /**
+     * Reads a GPX file's metadata tag, reading among other things:
+     *   - the name and description of this GPX
+     *   - its author
+     *   - the copyright associated with this GPX file
+     *
+     * Will return null if no metadata tag is present (or no valid source is given).
+     *
+     * @param {Document|Element|Object|string} source Source.
+     * @return {GPXMetadata | null} Metadata
+     * @api
+     */
+    readMetadata(source: Document | Element | any | string): GPXMetadata | null;
+    /**
+     * @param {Document} doc Document.
+     * @return {GPXMetadata | null} Metadata
+     */
+    readMetadataFromDocument(doc: Document): GPXMetadata | null;
+    /**
+     * @param {Element} node Node.
+     * @return {Object} Metadata
+     */
+    readMetadataFromNode(node: Element): any;
 }
 import Feature from '../Feature.js';
 import XMLFeature from './XMLFeature.js';

package/format/GPX.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GPX.d.ts","sourceRoot":"","sources":["GPX.js"],"names":[],"mappings":";;;;;;;;;;6BAkGuB,OAAO,QAAE,IAAI,KAAE,IAAI;;;;;;;;;;;;AAF1C;;;;;;;;GAQG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;;GAeG;AACH;IACE;;OAEG;IACH,2CAeC;IALC;;;OAGG;IACH,wBAA6C;IAG/C;;;OAGG;IACH,8BAYC;CAgFF;oBAlPmB,eAAe;uBAIZ,iBAAiB"}
+{"version":3,"file":"GPX.d.ts","sourceRoot":"","sources":["GPX.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6BA2KuB,OAAO,QAAE,IAAI,KAAE,IAAI;;;;;;;;;;;;AAF1C;;;;;;;;GAQG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;;;;;GAeG;AACH;IACE;;OAEG;IACH,2CAeC;IALC;;;OAGG;IACH,wBAA6C;IAG/C;;;OAGG;IACH,8BAYC;IAED;;;;;;;;;;;OAWG;IACH,qBAJW,QAAQ,GAAC,OAAO,SAAQ,MAAM,GAC7B,WAAW,GAAG,IAAI,CAc7B;IAED;;;OAGG;IACH,8BAHW,QAAQ,GACP,WAAW,GAAG,IAAI,CAY7B;IAED;;;OAGG;IACH,2BAHW,OAAO,OAgBjB;CAgFF;oBAvXmB,eAAe;uBAIZ,iBAAiB"}

package/format/GPX.js

@@ -10,6 +10,7 @@ import {
   OBJECT_PROPERTY_NODE_FACTORY,
   XML_SCHEMA_INSTANCE_URI,
   createElementNS,
+  isDocument,
   makeArrayPusher,
   makeArraySerializer,
   makeChildAppender,
@@ -17,6 +18,7 @@ import {
   makeSequence,
   makeSimpleNodeFactory,
   makeStructureNS,
+  parse,
   parseNode,
   pushParseAndPop,
   pushSerializeAndPop,
@@ -73,6 +75,12 @@ const GPX_PARSERS = makeStructureNS(NAMESPACE_URIS, {
   'wpt': makeArrayPusher(readWpt),
 });
 
+/**
+ * @typedef {Object} GPXLink
+ * @property {string} [text] text
+ * @property {string} [type] type
+ */
+
 /**
  * @const
  * @type {Object<string, Object<string, import("../xml.js").Parser>>}
@@ -83,6 +91,71 @@ const LINK_PARSERS = makeStructureNS(NAMESPACE_URIS, {
   'type': makeObjectPropertySetter(readString, 'linkType'),
 });
 
+/**
+ * @typedef {Object} GPXAuthor
+ * @property {string} [name] name
+ * @property {string} [email] email
+ * @property {GPXLink} [link] link
+ */
+
+/**
+ * @const
+ * @type {Object<string, Object<string, import("../xml.js").Parser>>}
+ */
+// @ts-ignore
+const AUTHOR_PARSERS = makeStructureNS(NAMESPACE_URIS, {
+  'name': makeObjectPropertySetter(readString),
+  'email': parseEmail,
+  'link': parseLink,
+});
+
+/**
+ * @typedef {Object} GPXMetadata
+ * @property {string} [name] name
+ * @property {string} [desc] desc
+ * @property {GPXAuthor} [author] author
+ * @property {GPXLink} [link] link
+ * @property {number} [time] time
+ * @property {string} [keywords] keywords
+ * @property {Array<number>} [bounds] bounds
+ * @property {Object} [extensions] extensions
+ *
+ */
+
+/**
+ * @const
+ * @type {Object<string, Object<string, import("../xml.js").Parser>>}
+ */
+// @ts-ignore
+const METADATA_PARSERS = makeStructureNS(NAMESPACE_URIS, {
+  'name': makeObjectPropertySetter(readString),
+  'desc': makeObjectPropertySetter(readString),
+  'author': makeObjectPropertySetter(readAuthor),
+  'copyright': makeObjectPropertySetter(readCopyright),
+  'link': parseLink,
+  'time': makeObjectPropertySetter(readDateTime),
+  'keywords': makeObjectPropertySetter(readString),
+  'bounds': parseBounds,
+  'extensions': parseExtensions,
+});
+
+/**
+ * @typedef {Object} GPXCopyright
+ * @property {string} [author] author
+ * @property {number} [year] year
+ * @property {string} [license] license
+ */
+
+/**
+ * @const
+ * @type {Object<string, Object<string, import("../xml.js").Parser>>}
+ */
+// @ts-ignore
+const COPYRIGHT_PARSERS = makeStructureNS(NAMESPACE_URIS, {
+  'year': makeObjectPropertySetter(readPositiveInteger),
+  'license': makeObjectPropertySetter(readString),
+});
+
 /**
  * @const
  * @type {Object<string, Object<string, import("../xml.js").Serializer>>}
@@ -165,6 +238,66 @@ class GPX extends XMLFeature {
     }
   }
 
+  /**
+   * Reads a GPX file's metadata tag, reading among other things:
+   *   - the name and description of this GPX
+   *   - its author
+   *   - the copyright associated with this GPX file
+   *
+   * Will return null if no metadata tag is present (or no valid source is given).
+   *
+   * @param {Document|Element|Object|string} source Source.
+   * @return {GPXMetadata | null} Metadata
+   * @api
+   */
+  readMetadata(source) {
+    if (!source) {
+      return null;
+    }
+    if (typeof source === 'string') {
+      return this.readMetadataFromDocument(parse(source));
+    }
+    if (isDocument(source)) {
+      return this.readMetadataFromDocument(/** @type {Document} */ (source));
+    }
+    return this.readMetadataFromNode(source);
+  }
+
+  /**
+   * @param {Document} doc Document.
+   * @return {GPXMetadata | null} Metadata
+   */
+  readMetadataFromDocument(doc) {
+    for (let n = /** @type {Node} */ (doc.firstChild); n; n = n.nextSibling) {
+      if (n.nodeType === Node.ELEMENT_NODE) {
+        const metadata = this.readMetadataFromNode(/** @type {Element} */ (n));
+        if (metadata) {
+          return metadata;
+        }
+      }
+    }
+    return null;
+  }
+
+  /**
+   * @param {Element} node Node.
+   * @return {Object} Metadata
+   */
+  readMetadataFromNode(node) {
+    if (!NAMESPACE_URIS.includes(node.namespaceURI)) {
+      return null;
+    }
+    for (let n = node.firstElementChild; n; n = n.nextElementSibling) {
+      if (
+        NAMESPACE_URIS.includes(n.namespaceURI) &&
+        n.localName === 'metadata'
+      ) {
+        return pushParseAndPop({}, METADATA_PARSERS, n, []);
+      }
+    }
+    return null;
+  }
+
   /**
    * @param {Element} node Node.
    * @param {import("./Feature.js").ReadOptions} [options] Options.
@@ -589,6 +722,72 @@ function applyLayoutOptions(layoutOptions, flatCoordinates, ends) {
   return layout;
 }
 
+/**
+ * @param {Element} node Node.
+ * @param {Array<any>} objectStack Object stack.
+ * @return {GPXAuthor | undefined} Person object.
+ */
+function readAuthor(node, objectStack) {
+  const values = pushParseAndPop({}, AUTHOR_PARSERS, node, objectStack);
+  if (values) {
+    return values;
+  }
+  return undefined;
+}
+
+/**
+ * @param {Element} node Node.
+ * @param {Array<any>} objectStack Object stack.
+ * @return {GPXCopyright | undefined} Person object.
+ */
+function readCopyright(node, objectStack) {
+  const values = pushParseAndPop({}, COPYRIGHT_PARSERS, node, objectStack);
+  if (values) {
+    const author = node.getAttribute('author');
+    if (author !== null) {
+      values['author'] = author;
+    }
+    return values;
+  }
+  return undefined;
+}
+
+/**
+ * @param {Element} node Node.
+ * @param {Array<*>} objectStack Object stack.
+ */
+function parseBounds(node, objectStack) {
+  const values = /** @type {Object} */ (objectStack[objectStack.length - 1]);
+  const minlat = node.getAttribute('minlat');
+  const minlon = node.getAttribute('minlon');
+  const maxlat = node.getAttribute('maxlat');
+  const maxlon = node.getAttribute('maxlon');
+  if (
+    minlon !== null &&
+    minlat !== null &&
+    maxlon !== null &&
+    maxlat !== null
+  ) {
+    values['bounds'] = [
+      [parseFloat(minlon), parseFloat(minlat)],
+      [parseFloat(maxlon), parseFloat(maxlat)],
+    ];
+  }
+}
+
+/**
+ * @param {Element} node Node.
+ * @param {Array<*>} objectStack Object stack.
+ */
+function parseEmail(node, objectStack) {
+  const values = /** @type {Object} */ (objectStack[objectStack.length - 1]);
+  const id = node.getAttribute('id');
+  const domain = node.getAttribute('domain');
+  if (id !== null && domain !== null) {
+    values['email'] = `${id}@${domain}`;
+  }
+}
+
 /**
  * @param {Element} node Node.
  * @param {Array<*>} objectStack Object stack.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ol",
-  "version": "9.0.0-dev.1706533843703",
+  "version": "9.0.0-dev.1706603894900",
   "description": "OpenLayers mapping library",
   "keywords": [
     "map",

package/util.js

@@ -33,4 +33,4 @@ export function getUid(obj) {
  * OpenLayers version.
  * @type {string}
  */
-export const VERSION = '9.0.0-dev.1706533843703';
+export const VERSION = '9.0.0-dev.1706603894900';