aspernaturalias 1.0.0

package/.prettierignore

@@ -0,0 +1,2 @@
+package.json
+package-lock.json

package/.travis.yml

@@ -0,0 +1,31 @@
+language: node_js
+sudo: false
+notifications:
+  email: false
+  slack:
+    secure: KghYpsaoCZB1sPOqk1d+JhfBOkg76Cq8eMK665ozdf484RdPvObqLrxyrt9i+sDMDv/oZT+VuvGXsbHj6R+TUh87r2Yhfizcwvdotc4VTHei4y/oNX6cRhV8ryQox/0j6GClqI43A4kIsuOcUm8pI4FTGOhDQOK7+UDcuvcSa5VR7N7GJ97zfzC9gQtRsbfD5WKY4BEr+KlcWt0KCCbp1+Jh7craEO30ztUl38BuUuW7F1/AykrTX6kgS5E5ssUQ0pJPBlzpjb3G5UEeodzOD9wUBVLIBAbgQsofAPLi0pHeyCCeEOuTxXEo7SD8fG+kBstPlncR+V8goCEBnAJysIvBznUxLjrnxcU7V40g+iTENKwhVTIiZzZN3Z9buJd001MRaWjOTCWX80Ig6oraH8WJk7W1qtKzsDK9Lsp2N9pxNTPASbAQoFDlMCGcWYGixq6IhIAwsk1Pkb689F67vHaES8qMXkIHifB0j7yRMwrHinYFqUYASQOECPNEMJv3iqByXntmMP8X/r3VBujMehGodZ1dnbWvAOdWdEmG3KCVpn42ocKCj6k4WZL62nSxs3W00E1UVPnXujT3ENk/3L/VJE3tRWFCSbR9HnfBSDVA6WaFu4EFDg8WV6fn2T0FHKTBgCtTugQo8bsoyReYZvEU/27O/B+d5/9nqMHqyy4=
+node_js:
+- '10'
+- '11'
+cache: npm
+script:
+- npm run test:ci
+- codecov
+deploy:
+  provider: pages
+  skip_cleanup: true
+  keep-history: true
+  github_token: "$GITHUB_TOKEN"
+  on:
+    branch: master
+  local-dir: docs/build/arcgis-rest-js
+before_deploy:
+- npm run docs:build
+env:
+- MOZ_HEADLESS=1
+addons:
+  chrome: stable
+  firefox: latest
+branches:
+  only:
+    - master

package/.vscode/launch.json

@@ -0,0 +1,24 @@
+{
+  // Use IntelliSense to learn about possible Node.js debug attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug Node Tests",
+      "program": "${workspaceRoot}/node_modules/.bin/jasmine",
+      "args": [
+        "--config=jasmine.json"
+      ]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug Changelog Script",
+      "program": "${workspaceRoot}/support/changelog.js",
+      "args": ["--config=jasmine.json"]
+    }
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "editor.tabSize": 2
+}

package/codecov.yml

@@ -0,0 +1,3 @@
+coverage:
+  round: up
+  range: 0..10

package/demos/ago-node-cli/README.md

@@ -0,0 +1,29 @@
+# Node CLI Examples
+
+This demo shows how to create a command-line application that interacts with the ArcGIS Online API.
+
+At this point, the commands are very simple and intended to demonstrate how to build up tooling.
+
+This project uses the `commander` module, which streamlines the creation of node cli applications. Check out the [README](https://github.com/tj/commander.js/blob/master/Readme.md) for more details.
+
+### Installing
+
+Like all the other demo apps, run `npm run bootstrap` from the root.
+
+### Running
+If you use this demo as a starting point for your own command line package, you would publish it to npm, then on the target systems run `npm install <your-cli-package>`, and it would be available as a command.
+
+But, this is demo code, and thus the package is not "installed" via `npm install ...`, before we can call it as `ago <command> <query>` we need to run `npm link` in the `/demos/ago-node-cli` folder. After you do that, the command should work.
+
+Here is a post with information on creating node command line tools: [A Guide to Creating a NodeJs Command](https://x-team.com/blog/a-guide-to-creating-a-nodejs-command/)
+
+### Commands
+
+| command | description | example |
+| --- | --- | --- |
+| `ago search <query>` | search for items | `ago search water` |
+| `ago export <id> <file>` | export an item to a json file | `ago export a62cb9d894f145cc89531c096d0012b1 pa.json` |
+
+## Building your own tooling
+
+If you want to build out some commands of your own, you can also clone a stand-alone version of this repo from https://github.com/dbouwman/arcgis-rest-js-commands

package/demos/ago-node-cli/ago.js

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+require('cross-fetch/polyfill');
+require('isomorphic-form-data');
+
+/**
+ * This demo uses the commander module, which streamlines the creation of command-line-applications
+ */
+const program = require('commander');
+
+program
+  .version('0.0.1');
+
+/**
+ * Bring in the search command...
+ */
+const itemSearchCommand = require('./lib/item-search-command');
+
+program
+  .command('search <query>')
+  .description('Search for items')
+  .action(function (query) {
+    itemSearchCommand.execute(query);
+  });
+
+  const itemExportCommand = require('./lib/item-export-command');
+  program
+  .command('export <itemId> <filename>')
+  .description('Export an item to a json file')
+  .action(function (id, filename) {
+    itemExportCommand.execute(id, filename);
+  });
+
+program.parse(process.argv);

package/demos/ago-node-cli/index.js

@@ -0,0 +1,11 @@
+/**
+ * Re-export the commands so they can be used in other contexts
+ */
+const itemSearchCommand = require('./lib/item-search-command');
+const itemExportCommand = require('./lib/item-export-command');
+
+// just re-export the commands so they can be run in another scropt
+module.exports = {
+  search: itemSearchCommand,
+  export: itemExportCommand
+};

package/demos/ago-node-cli/lib/item-export-command.js

@@ -0,0 +1,48 @@
+const { getItem, getItemData } = require("@esri/arcgis-rest-portal");
+const jsonfile = require('jsonfile');
+
+module.exports = {
+  /**
+   * Execute the command
+   */
+  execute: function (id, fileName) {
+    console.info(`Exporting item ${id} to file ${fileName}`);
+    // construct the search call..
+    let model = {};
+    return getItem(id)
+    .then((item) => {
+      model.item = item;
+      if (this.shouldFetchData(item.type)){
+        console.info(`...Fetching ./data for item of type ${item.type}`);
+        return getItemData(id);
+      } else {
+        console.info(`...Items of type ${item.type} do not have json ./data - skipping`);
+        return Promise.resolve();
+      }
+    })
+    .then((maybeData) => {
+      if (maybeData) {
+        model.data = maybeData;
+      }
+      // now write out the file...
+      jsonfile.writeFileSync(fileName, model,  {spaces: 2});
+      console.info(`Done. Exported "${model.item.title}" to ${fileName}`);
+    })
+    .catch((err) => {
+      console.error(err);
+    });
+  },
+
+  /**
+   * Not all item types have json /data
+   */
+  shouldFetchData (type) {
+    let result = false;
+    let exportables = ['Web Map', 'Web Mapping Application', 'Hub Page', 'Hub Initiative', 'Hub Site Application'];
+    // if the type is in this list, we can export it...
+    if (exportables.indexOf(type) > -1) {
+      result = true;
+    }
+    return result;
+  }
+}

package/demos/ago-node-cli/lib/item-search-command.js

@@ -0,0 +1,35 @@
+
+/**
+ * Bring in searchItems fn
+ */
+const { searchItems } = require("@esri/arcgis-rest-portal");
+
+module.exports = {
+  /**
+   * Execute the command
+   */
+  execute: function (query) {
+    // construct the search call..
+    return searchItems({
+      searchForm: {
+        q: query,
+        start: 1,
+        num: 10
+      }
+    })
+    .then((response) => {
+      // if we got results
+      if (Array.isArray(response.results) && response.results.length)  {
+        console.info(`${response.total} items found for "${query}".`);
+        response.results.forEach((entry) => {
+          console.info(`${entry.id} | ${entry.title}`);
+        })
+      } else {
+        console.info(`No results found for "${query}".`);
+      }
+    })
+    .catch((err) => {
+      console.error(err);
+    });
+  }
+}

package/demos/ago-node-cli/package-lock.json

@@ -0,0 +1,152 @@
+{
+	"requires": true,
+	"lockfileVersion": 1,
+	"dependencies": {
+		"ansi-styles": {
+			"version": "3.2.1",
+			"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz",
+			"integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==",
+			"requires": {
+				"color-convert": "^1.9.0"
+			}
+		},
+		"async": {
+			"version": "2.6.1",
+			"resolved": "https://registry.npmjs.org/async/-/async-2.6.1.tgz",
+			"integrity": "sha512-fNEiL2+AZt6AlAw/29Cr0UDe4sRAHCpEHh54WMz+Bb7QfNcFw4h3loofyJpLeQs4Yx7yuqu/2dLgM5hKOs6HlQ==",
+			"requires": {
+				"lodash": "^4.17.10"
+			}
+		},
+		"chalk": {
+			"version": "2.4.1",
+			"resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.1.tgz",
+			"integrity": "sha512-ObN6h1v2fTJSmUXoS3nMQ92LbDK9be4TV+6G+omQlGJFdcUX5heKi1LZ1YnRMIgwTLEj3E24bT6tYni50rlCfQ==",
+			"requires": {
+				"ansi-styles": "^3.2.1",
+				"escape-string-regexp": "^1.0.5",
+				"supports-color": "^5.3.0"
+			}
+		},
+		"color-convert": {
+			"version": "1.9.3",
+			"resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz",
+			"integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==",
+			"requires": {
+				"color-name": "1.1.3"
+			}
+		},
+		"color-name": {
+			"version": "1.1.3",
+			"resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz",
+			"integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU="
+		},
+		"combined-stream": {
+			"version": "1.0.7",
+			"resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.7.tgz",
+			"integrity": "sha512-brWl9y6vOB1xYPZcpZde3N9zDByXTosAeMDo4p1wzo6UMOX4vumB+TP1RZ76sfE6Md68Q0NJSrE/gbezd4Ul+w==",
+			"requires": {
+				"delayed-stream": "~1.0.0"
+			}
+		},
+		"commander": {
+			"version": "2.19.0",
+			"resolved": "https://registry.npmjs.org/commander/-/commander-2.19.0.tgz",
+			"integrity": "sha512-6tvAOO+D6OENvRAh524Dh9jcfKTYDQAqvqezbCW82xj5X0pSrcpxtvRKHLG0yBY6SD7PSDrJaj+0AiOcKVd1Xg=="
+		},
+		"cross-fetch": {
+			"version": "3.0.2",
+			"resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.0.2.tgz",
+			"integrity": "sha512-a4Z0EJ5Nck6QtMy9ZqloLfpvu2uMV3sBfMCR+CgSBCZc6z5KR4bfEiD3dkepH8iZgJMXQpTqf8FjMmvu/GMFkg==",
+			"requires": {
+				"node-fetch": "2.3.0",
+				"whatwg-fetch": "3.0.0"
+			},
+			"dependencies": {
+				"node-fetch": {
+					"version": "2.3.0",
+					"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.3.0.tgz",
+					"integrity": "sha512-MOd8pV3fxENbryESLgVIeaGKrdl+uaYhCSSVkjeOb/31/njTpcis5aWfdqgNlHIrKOLRbMnfPINPOML2CIFeXA=="
+				}
+			}
+		},
+		"delayed-stream": {
+			"version": "1.0.0",
+			"resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz",
+			"integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk="
+		},
+		"escape-string-regexp": {
+			"version": "1.0.5",
+			"resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
+			"integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ="
+		},
+		"form-data": {
+			"version": "1.0.1",
+			"resolved": "http://registry.npmjs.org/form-data/-/form-data-1.0.1.tgz",
+			"integrity": "sha1-rjFduaSQf6BlUCMEpm13M0de43w=",
+			"requires": {
+				"async": "^2.0.1",
+				"combined-stream": "^1.0.5",
+				"mime-types": "^2.1.11"
+			}
+		},
+		"graceful-fs": {
+			"version": "4.1.15",
+			"resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.1.15.tgz",
+			"integrity": "sha512-6uHUhOPEBgQ24HM+r6b/QwWfZq+yiFcipKFrOFiBEnWdy5sdzYoi+pJeQaPI5qOLRFqWmAXUPQNsielzdLoecA==",
+			"optional": true
+		},
+		"has-flag": {
+			"version": "3.0.0",
+			"resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
+			"integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0="
+		},
+		"isomorphic-form-data": {
+			"version": "1.0.0",
+			"resolved": "https://registry.npmjs.org/isomorphic-form-data/-/isomorphic-form-data-1.0.0.tgz",
+			"integrity": "sha1-BEe+fg9rht7z05MDbPdmSpiRkQA=",
+			"requires": {
+				"form-data": "^1.0.0-rc3"
+			}
+		},
+		"jsonfile": {
+			"version": "4.0.0",
+			"resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz",
+			"integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=",
+			"requires": {
+				"graceful-fs": "^4.1.6"
+			}
+		},
+		"lodash": {
+			"version": "4.17.11",
+			"resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.11.tgz",
+			"integrity": "sha512-cQKh8igo5QUhZ7lg38DYWAxMvjSAKG0A8wGSVimP07SIUEK2UO+arSRKbRZWtelMtN5V0Hkwh5ryOto/SshYIg=="
+		},
+		"mime-db": {
+			"version": "1.37.0",
+			"resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.37.0.tgz",
+			"integrity": "sha512-R3C4db6bgQhlIhPU48fUtdVmKnflq+hRdad7IyKhtFj06VPNVdk2RhiYL3UjQIlso8L+YxAtFkobT0VK+S/ybg=="
+		},
+		"mime-types": {
+			"version": "2.1.21",
+			"resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.21.tgz",
+			"integrity": "sha512-3iL6DbwpyLzjR3xHSFNFeb9Nz/M8WDkX33t1GFQnFOllWk8pOrh/LSrB5OXlnlW5P9LH73X6loW/eogc+F5lJg==",
+			"requires": {
+				"mime-db": "~1.37.0"
+			}
+		},
+		"supports-color": {
+			"version": "5.5.0",
+			"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
+			"integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==",
+			"requires": {
+				"has-flag": "^3.0.0"
+			}
+		},
+		"whatwg-fetch": {
+			"version": "3.0.0",
+			"resolved": "https://registry.npmjs.org/whatwg-fetch/-/whatwg-fetch-3.0.0.tgz",
+			"integrity": "sha512-9GSJUgz1D4MfyKU7KRqwOjXCXTqWdFNvEr7eUBYchQiVc744mqK/MzXPNR2WsPkmkOa4ywfg8C2n8h+13Bey1Q=="
+		}
+	}
+}

package/demos/ago-node-cli/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "node-cli",
+  "version": "2.0.4",
+  "description": "arcgis-rest-js node command-line item search example",
+  "main": "ago.js",
+  "scripts": {
+    "start": "echo \"CLI - node index.js <search>\" && exit 1"
+  },
+  "bin": {
+    "ago": "./ago.js"
+  },
+  "private": true,
+  "keywords": [
+    "arcgis",
+    "node",
+    "arcgis-rest-js"
+  ],
+  "author": "Dave Bouwman <dbouwman@esri.com>",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@esri/arcgis-rest-auth": "^2.0.4",
+    "@esri/arcgis-rest-portal": "^2.0.4",
+    "@esri/arcgis-rest-request": "^2.0.4",
+    "chalk": "^2.3.0",
+    "commander": "^2.12.2",
+    "cross-fetch": "^3.0.0",
+    "isomorphic-form-data": "^1.0.0",
+    "jsonfile": "^4.0.0"
+  }
+}

package/demos/attachments/README.md

@@ -0,0 +1,5 @@
+# Running this demo
+
+1. Make sure you run `npm run bootstrap` in the root folder to setup the dependencies
+1. `npm start`
+1. Visit http://localhost:8080

package/demos/attachments/index.html

@@ -0,0 +1,164 @@
+<!DOCTYPE html>
+<html>
+<title>Attachments</title>
+
+<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
+
+<script src="https://polyfill.io/v3/polyfill.min.js?features=es5%2Cfetch%2CPromise"></script>
+
+<div class="container-fluid">
+  <div class="row">
+    <div class="col-md-12">
+      <h3>Attachments</h3>
+      <form id="getForm">
+        <div class="form-group">
+          <label for="serviceUrl">Service URL</label>
+          <input type="text" id="serviceUrl" name="serviceUrl" class="form-control" value="http://sampleserver6.arcgisonline.com/arcgis/rest/services/SF311/FeatureServer/0/" required>
+        </div>
+        <div class="form-group">
+          <label for="featureId">Feature ID</label>
+          <input type="number" min="0" step="1" id="featureId" name="featureId" class="form-control" value="3339970" required>
+        </div>
+        <div class="form-group">
+          <button type="submit" class="btn"><span class="glyphicon glyphicon-paperclip" aria-hidden="true"></span> Get Attachments</button>
+        </div>
+      </form>
+    </div>
+  </div>
+  <div class="row">
+    <div class="col-md-12">
+      <form id="addForm">
+        <div class="form-group">
+          <label for="attachFile">File</label>
+          <input type="file" id="attachFile" name="attachFile" required>
+        </div>
+        <div class="form-group">
+          <button type="submit" class="btn btn-success"><span class="glyphicon glyphicon-plus" aria-hidden="true"></span> Add Attachment</button>
+        </div>
+      </form>
+    </div>
+  </div>
+  <div class="row">
+    <div class="col-md-12">
+      <p id="resultMessage"></p>
+      <table class="table table-striped">
+        <thead>
+          <th>Attachment ID</th>
+          <th>Content Type</th>
+          <th>Size</th>
+          <th>Attachment</th>
+          <th>Delete</th>
+        </thead>
+        <tbody id="result"></tbody>
+      </table>
+    </div>
+  </div>
+</div>
+
+<script src="https://rawgit.com/kriszyp/put-selector/master/put.js"></script>
+<script src="node_modules/@esri/arcgis-rest-request/dist/umd/request.umd.js"></script>
+<script src="node_modules/@esri/arcgis-rest-feature-service/dist/umd/feature-service.umd.js"></script>
+
+<script>
+  let serviceUrl, featureId;
+
+  let validService = false;
+
+  // ref some nodes
+  const getForm = document.getElementById('getForm');
+  const addForm = document.getElementById('addForm');
+  const resultMessage = document.getElementById('resultMessage');
+  const result = document.getElementById('result');
+
+  // delete attachment and get again to update table rows
+  const deleteAttachment = attachmentId => {
+    arcgisRest.deleteAttachments({
+      url: serviceUrl,
+      featureId: featureId,
+      attachmentIds: [attachmentId]
+    }).then(res => {
+      console.log(res);
+      arcgisRest.getAttachments({
+        url: serviceUrl,
+        featureId: featureId
+      }).then(getResponse).catch(getError);
+    }).catch(err => {
+      console.log(err);
+      alert(err.message + ' Check the console for more details.');
+    });
+  }
+
+  // handle get attachments response and create table rows
+  const getResponse = res => {
+    console.log(res);
+    const infos = res.attachmentInfos;
+    validService = true;
+    resultMessage.innerHTML = 'Feature has ' + infos.length + ' attachments.';
+    result.innerHTML = '';
+    if (infos.length) {
+      infos.forEach(info => {
+        const tr = put(result, 'tr');
+        put(tr, 'td', info.id);
+        put(tr, 'td', info.contentType);
+        put(tr, 'td', info.size);
+        put(tr, 'td a.btn.btn-primary', {
+          target: '_blank',
+          href: serviceUrl + '/' + featureId + '/attachments/' + info.id,
+          innerHTML: '<span class="glyphicon glyphicon-file" aria-hidden="true"></span> ' + info.name
+        });
+        put(tr, 'td a.btn.btn-danger', {
+          href: '#',
+          innerHTML: '<span class="glyphicon glyphicon-remove" aria-hidden="true"></span> ' + info.name,
+          onclick: evt => {
+            evt.preventDefault();
+            deleteAttachment(info.id);
+          }
+        });
+      });
+    }
+  };
+
+  // handle get attachments error
+  const getError = err => {
+    console.log(err);
+    validService = false;
+    resultMessage.innerHTML = err.message + ' Check the console for more details.';
+    result.innerHTML = '';
+  }
+
+  // handle get attachments form submit
+  getForm.addEventListener('submit', function (evt) {
+    evt.preventDefault();
+    arcgisRest.getAttachments({
+      url: serviceUrl = getForm.serviceUrl.value,
+      featureId: featureId = getForm.featureId.value
+    }).then(getResponse).catch(getError);
+  });
+
+  // handle add attachment form submit and get again to update table rows
+  addForm.addEventListener('submit', function (evt) {
+    evt.preventDefault();
+    if (!validService) {
+      alert('Not so fast. Start by getting a feature\'s attachments first.');
+      return;
+    }
+    arcgisRest.addAttachment({
+      url: serviceUrl,
+      featureId: featureId,
+      attachment: evt.target.attachFile.files[0],
+      params: {
+        returnEditMoment: true
+      }
+    }).then(res => {
+      console.log(res);
+      arcgisRest.getAttachments({
+        url: serviceUrl,
+        featureId: featureId
+      }).then(getResponse).catch(getError);
+    }).catch(err => {
+      console.log(err);
+      alert(err.message + ' Check the console for more details.');
+    });
+  });
+</script>
+</html>