canada-api 1.0.3 → 1.1.0

package/README.md

@@ -5,7 +5,7 @@ Cross platform API for fetching public data from [canada.ca](https://www.canada.
 ## Install
 ### Browsers
 
-    <script src="https://cdn.jsdelivr.net/npm/canada-api@1.0.3"><script>
+    <script src="https://cdn.jsdelivr.net/npm/canada-api@1.1.0"><script>
 
 ### Nodejs
 
@@ -31,7 +31,7 @@ Uses sitemaps to fetch an array of child nodes
     ca.children("/en/department-national-defence/maple-leaf")
     ca.children("/fr/ministere-defense-nationale/feuille-derable")
 
-Returns: `Promise` Resolves: Array of objects with `path` properties
+Returns: `Promise` Resolves: node object with `children` property
 
 Only for page nodes, other types return an error `Not Found`
 
@@ -42,7 +42,7 @@ Fetches metadata of a node
     ca.meta("/en/department-national-defence/maple-leaf")
     ca.meta("/content/dam/dnd-mdn/images/maple-leaf/ml-logo.jpg")
 
-Returns: `Promise` Resolves: Object with `meta` property
+Returns: `Promise` Resolves: node object with `meta` property
 
 ### ca.content(node)
 
@@ -51,7 +51,7 @@ Fetches content of a node, as text or json
     ca.content("/en/department-national-defence/maple-leaf")
     ca.content("/content/dam/dnd-mdn/documents/json/maple-en.json")
 
-Returns: `Promise` Resolves: Object with `content` property
+Returns: `Promise` Resolves: node object with `content` property
 
 ## Arguments
 
@@ -62,7 +62,6 @@ All functions take a node argument which accepts a couple types
 Valid path strings include:
 
     en/department-national-defence
-    /en/department-national-defence/
     /en/department-national-defence.html
     /en/department-national-defence?param=ignored
     

package/package.json

@@ -1,36 +1,36 @@
-{
-  "name": "canada-api",
-  "version": "1.0.3",
-  "description": "Cross platform API to fetch data from canada.ca",
-  "browser": "dist/ca.js",
-  "main": "src/index.mjs",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "webpack",
-    "dev": "webpack --mode development"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/bsoicher/canada-api.git"
-  },
-  "keywords": [
-    "canada",
-    "api",
-    "fetch"
-  ],
-  "author": "Ben Soicher",
-  "license": "MIT",
-  "homepage": "https://github.com/bsoicher/canada-api#readme",
-  "bugs": "https://github.com/bsoicher/canada-api/issues",
-  "devDependencies": {
-    "webpack": "^5.72.0",
-    "webpack-cli": "^4.9.2"
-  },
-  "dependencies": {
-    "bottleneck": "^2.19.5",
-    "cross-fetch": "^3.1.5"
-  },
-  "engines": {
-    "node": ">= 10.0.0"
-  }
-}
+{
+  "name": "canada-api",
+  "version": "1.1.0",
+  "description": "Cross platform API to fetch data from canada.ca",
+  "browser": "dist/ca.js",
+  "main": "src/index.mjs",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "webpack",
+    "dev": "webpack --mode development"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bsoicher/canada-api.git"
+  },
+  "keywords": [
+    "canada",
+    "api",
+    "fetch"
+  ],
+  "author": "Ben Soicher",
+  "license": "MIT",
+  "homepage": "https://github.com/bsoicher/canada-api#readme",
+  "bugs": "https://github.com/bsoicher/canada-api/issues",
+  "devDependencies": {
+    "webpack": "^5.72.0",
+    "webpack-cli": "^4.9.2"
+  },
+  "dependencies": {
+    "bottleneck": "^2.19.5",
+    "cross-fetch": "^3.1.5"
+  },
+  "engines": {
+    "node": ">= 10.0.0"
+  }
+}

package/src/index.mjs

@@ -26,8 +26,12 @@ const months = {
  * @param {string} date
  * @returns {Date}
  */
-function parseDate(date) {
-    let m = /^\w{3} (\w{3}) (\d{2}) (\d{4}) ([\d:]{8}) GMT([\-+]\d{4})$/.exec(date)
+function maybeParseDate(date) {
+    if (/^\d{4}-\d{2}-\d{2}$/.test(date)) {
+        return Date.parse(date)
+    }
+
+    m = /^\w{3} (\w{3}) (\d{2}) (\d{4}) ([\d:]{8}) GMT([\-+]\d{4})$/.exec(date)
     return m ? Date.parse(m[3] + '-' + months[m[1]] + '-' + m[2] + 'T' + m[4] + m[5]) : date
 }
 
@@ -95,20 +99,17 @@ function normalizeNode(node) {
 }
 
 /**
- * Verify if fetch succeeded
+ * Verify response properties
  * @param {Response} response
- * @throws {Error} Fetch failed to load as expected
+ * @throws {Error} Bad response
  * @returns {Response}
  */
 function verifyResponse(response) {
     if (!response.ok) {
-        // Bad http response
         throw new Error(response.statusText)
     } else if (!response.url.includes(domain)) {
-        // Redirected outside of domain
         throw new Error('Redirect')
-    } else if (response.url.includes('/errors/404.html')) {
-        // 404 document was loaded
+    } else if (response.url.includes('/404.html')) {
         throw new Error('Not Found')
     }
 
@@ -116,10 +117,9 @@ function verifyResponse(response) {
 }
 
 /**
- * Get node children by parsing sitemaps
- * @param {string|Object} node 
- * @param {array} list Node list to extend
- * @returns {Object}
+ * Get node children from XML sitemap
+ * @param {string|Object} node
+ * @returns {Promise<Object>}
  */
 export function children(node) {
     node = normalizeNode(node)
@@ -127,21 +127,30 @@ export function children(node) {
     return limiter.schedule(() => fetch(formatURL(node.path, '.sitemap.xml')))
         .then(verifyResponse)
         .then(response => response.text())
-        .then(xml => xml.match(/<url>.*?<\/url>/g).map(url => {
-            let loc = url.match(/<loc>([^<]+)<\/loc>/)
-            let mod = url.match(/<lastmod>([^<]+)<\/lastmod>/)
-            return {
-                path: normalizePath(loc[1]),
-                lastmod: mod ? Date.parse(mod[1]) : null
+        .then(xml => {
+            // Parse XML
+            node.children = xml.match(/<url>.*?<\/url>/g).map(url => {
+                let loc = url.match(/<loc>([^<]+)<\/loc>/)
+                let mod = url.match(/<lastmod>([^<]+)<\/lastmod>/)
+                return {
+                    path: normalizePath(loc[1]),
+                    lastmod: mod ? Date.parse(mod[1]) : null
+                }
+            })
+
+            // First entry may be the input node
+            if (node.children.length && node.children[0].path === node.path) {
+                node.lastmod = node.children.shift().lastmod
             }
-        }))
-        .catch(() => [])
+
+            return node
+        })
 }
 
 /**
- * Get node metadata
- * @param {string|Object} node 
- * @returns {Object}
+ * Get node metadata from jcr content
+ * @param {string|Object} node
+ * @returns {Promise<Object>}
  */
 export function meta(node) {
     node = normalizeNode(node)
@@ -150,32 +159,28 @@ export function meta(node) {
         .then(verifyResponse)
         .then(response => response.json())
         .then(meta => {
-            // Format properties
-            for (var key in meta) {
+            // Reformat some meta properties
+            Object.keys(meta).forEach(key => {
                 if (meta[key] === 'true') {
                     meta[key] = true
                 } else if (meta[key] === 'false') {
                     meta[key] = false
                 } else if (key.endsWith('@TypeHint')) {
                     delete meta[key]
-                } else if (typeof meta[key] === 'string' && meta[key].length === 33) {
-                    meta[key] = parseDate(meta[key])
+                } else if (typeof meta[key] === 'string') {
+                    meta[key] = maybeParseDate(meta[key])
                 }
-            }
+            })
 
             node.meta = meta
             return node
         })
-        .catch(err => {
-            node.meta = err
-            return node
-        })
 }
 
 /**
  * Get node content
  * @param {string|Object} node 
- * @returns {Object}
+ * @returns {Promise<Object>}
  */
 export function content(node) {
     node = normalizeNode(node)
@@ -193,9 +198,4 @@ export function content(node) {
             node.content = content
             return node
         })
-        .catch(err => {
-            node.content = err
-            return node
-        })
 }
-