npm - culparepellendus - Versions diffs - 1.0.0 - Mend

culparepellendus 1.0.0

Files changed (470) hide show

package/demos/jsapi-integration/README.md ADDED Viewed

@@ -0,0 +1,25 @@
+# Passing authentication to the JSAPI
+This demo shows how to use `arcgis-rest-js` with  the ArcGIS API for JavaScript. A typical use case would be when you need to query items or feature data _before_ you are ready to display a map or scene view. In this scenario, you should load the light-weight `arcgis-rest-js` libraries first and use them to perform your queries and/or authenticate with the ArcGIS platform. Then when you are ready to show a map or scene view, you would lazy-load the ArcGIS API for JavaScript with something like [esri-loader](https://github.com/Esri/esri-loader) and use it to create the map.
+## Running this demo
+1. Run `npm run bootstrap` in the repository's root directory.
+1. Run `npm start` to spin up the development server.
+1. Visit [http://localhost:8080](http://localhost:8080).
+```js
+// from rest-js
+const session = new UserSession(/* */);
+// session wont fetch a token until a request is a made
+session.getToken("https://www.arcgis.com/sharing/rest")
+  .then(() => {
+    esriId.registerToken(session.toCredential()); // JSAPI Identity Manager
+  })
+// from jsapi
+esriId.getCredential("https://www.arcgis.com/sharing/rest")
+  .then(cred => {
+    const session = UserSession.fromCredential(cred);
+  })
+```

package/demos/jsapi-integration/config.js ADDED Viewed

@@ -0,0 +1,6 @@
+/*
+You can generate your own clientid by creating an application on the ArcGIS for Developers site. Be sure to add http://localhost:8080/ as a redirect uri for your application
+once you have a clientid of your own, copy/paste it here and rename this file 'config.js'
+*/
+let clientId = "UAbPGRdXA9m1BGsU"

package/demos/jsapi-integration/index.html ADDED Viewed

@@ -0,0 +1,93 @@
+<!DOCTYPE html>
+<html>
+  <head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no">
+  <title>Share auth between ArcGIS REST JS and the ArcGIS API for JavaScript</title>
+    <style>
+      html,
+      body,
+      #viewDiv {
+        padding: 0;
+        margin: 0;
+        height: 100%;
+        width: 100%;
+      }
+    </style>
+  <link rel="stylesheet" href="https://js.arcgis.com/4.20/esri/css/main.css">
+    <script src="node_modules/@esri/arcgis-rest-request/dist/umd/request.umd.js"></script>
+    <script src="node_modules/@esri/arcgis-rest-auth/dist/umd/auth.umd.js"></script>
+    <script src="node_modules/@esri/arcgis-rest-portal/dist/umd/portal.umd.js"></script>
+    <!--
+    NOTE: rather than include the ArcGIS API for JavaScript via a <script> tag
+    typically you would using something like https://github.com/Esri/esri-loader
+    to lazy-load the API _after_ you had used the light-weight arcgis-rest-js
+    libraries above to log in and fetch some data (see NOTE below)
+  -->
+    <script src="https://js.arcgis.com/4.20/"></script>
+  </head>
+  <body>
+    <div id="viewDiv"></div>
+    <script>
+      // First, log in
+      //
+      // NOTE: You should never store username/password in an HTML file like
+      // this in production - this is for demonstration purposes only.
+      const session = new arcgisRest.UserSession({
+        username: "YOUR_USERNAME",
+        password: "YOUR_PASSWORD"
+      });
+      // Next, fetch a private item's data (not just the metadata)
+      //
+      // Change this to an itemId of a private item to which the
+      // user above has access.
+      const itemId = "815064a5fc444679b386b68a50b8933";
+      arcgisRest.getItemData(itemId, { authentication: session })
+        .then(response => {
+        // once we have the private item, we can create a map
+        // NOTE: this is where you would lazy-load the ArcGIS API for JavaScript
+          require([
+            "esri/identity/IdentityManager",
+            "esri/views/MapView",
+            "esri/WebMap"
+          ], function(
+            esriId, MapView, WebMap
+          ) {
+          // Pass the authenticated session over to the ArcGIS API for
+          // JavaScript Identity Manager
+          esriId.registerToken(session.toCredential());
+          // display the title of its basemap
+          console.debug(response);
+          console.debug('baseMap title:', response.baseMap.title);
+          // create a map with the item
+          var webmap = new WebMap({
+            portalItem: {
+              id: itemId
+            }
+          });
+          // and pass it to the map view
+          var view = new MapView({
+            map: webmap,
+            container: "viewDiv"
+          });
+          // you can also pass credentials in the other direction
+          esriId.getCredential("https://arcgis.com/sharing/rest/")
+            .then(cred => {
+              const session2 = arcgisRest.UserSession.fromCredential(cred);
+            });
+        });
+      });
+    </script>
+  </body>
+</html>

package/demos/jsapi-integration/package-lock.json ADDED Viewed

@@ -0,0 +1,247 @@
+{
+  "name": "@esri/jsapi-integration",
+  "version": "3.2.1",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "@esri/arcgis-rest-auth": {
+      "version": "3.2.1",
+      "resolved": "https://registry.npmjs.org/@esri/arcgis-rest-auth/-/arcgis-rest-auth-3.2.1.tgz",
+      "integrity": "sha512-qIt06uv7OCL8i8y4xXhMwpf8PB2U2q0H6v/0k4VvrECS7BD7LVprChsKvp+utEEpYpUsooFx08BaE8usV4AVXw==",
+      "requires": {
+        "@esri/arcgis-rest-types": "^3.2.1",
+        "tslib": "^1.13.0"
+      }
+    },
+    "@esri/arcgis-rest-portal": {
+      "version": "3.2.1",
+      "resolved": "https://registry.npmjs.org/@esri/arcgis-rest-portal/-/arcgis-rest-portal-3.2.1.tgz",
+      "integrity": "sha512-Hdy0Qe7Voezjdzb+wvEGEVWFGmqU9e1avlPkdzComEU1VMSR3YrRnIBB945EqwvRzaplMoci1bUGEb/Wq4kNzQ==",
+      "requires": {
+        "@esri/arcgis-rest-types": "^3.2.1",
+        "tslib": "^1.13.0"
+      }
+    },
+    "@esri/arcgis-rest-request": {
+      "version": "3.2.1",
+      "resolved": "https://registry.npmjs.org/@esri/arcgis-rest-request/-/arcgis-rest-request-3.2.1.tgz",
+      "integrity": "sha512-uO3MNwQ5qfpn5aTIZc7OPgxmYkHyEmdUPvsXxz+MCbU/bDd+fcuEVXlw9F7n0tkxkYiiajVJjgxSF+sLc1nlRA==",
+      "requires": {
+        "tslib": "^1.10.0"
+      }
+    },
+    "@esri/arcgis-rest-types": {
+      "version": "3.2.1",
+      "resolved": "https://registry.npmjs.org/@esri/arcgis-rest-types/-/arcgis-rest-types-3.2.1.tgz",
+      "integrity": "sha512-lVOAhu0qvhQEm5BFSOp8VxqxkAd5dBa7ZNXhtuDNNyELy38R0C/0zt3ri4eQLpMIZG4oip/djinOLgzAdQZzBw=="
+    },
+    "async": {
+      "version": "1.5.2",
+      "resolved": "https://registry.npmjs.org/async/-/async-1.5.2.tgz",
+      "integrity": "sha1-7GphrlZIDAw8skHJVhjiCJL5Zyo=",
+      "dev": true
+    },
+    "colors": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/colors/-/colors-1.0.3.tgz",
+      "integrity": "sha1-BDP0TYCWgP3rYO0mDxsMJi6CpAs=",
+      "dev": true
+    },
+    "corser": {
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/corser/-/corser-2.0.1.tgz",
+      "integrity": "sha1-jtolLsqrWEDc2XXOuQ2TcMgZ/4c=",
+      "dev": true
+    },
+    "debug": {
+      "version": "2.6.8",
+      "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.8.tgz",
+      "integrity": "sha1-5zFTHKLt4n0YgiJCfaF4IdaP9Pw=",
+      "dev": true,
+      "requires": {
+        "ms": "2.0.0"
+      }
+    },
+    "eventemitter3": {
+      "version": "3.1.0",
+      "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-3.1.0.tgz",
+      "integrity": "sha512-ivIvhpq/Y0uSjcHDcOIccjmYjGLcP09MFGE7ysAwkAvkXfpZlC985pH2/ui64DKazbTW/4kN3yqozUxlXzI6cA==",
+      "dev": true
+    },
+    "follow-redirects": {
+      "version": "1.5.0",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.5.0.tgz",
+      "integrity": "sha512-fdrt472/9qQ6Kgjvb935ig6vJCuofpBUD14f9Vb+SLlm7xIe4Qva5gey8EKtv8lp7ahE1wilg3xL1znpVGtZIA==",
+      "dev": true,
+      "requires": {
+        "debug": "^3.1.0"
+      },
+      "dependencies": {
+        "debug": {
+          "version": "3.1.0",
+          "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz",
+          "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==",
+          "dev": true,
+          "requires": {
+            "ms": "2.0.0"
+          }
+        }
+      }
+    },
+    "he": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/he/-/he-1.1.1.tgz",
+      "integrity": "sha1-k0EP0hsAlzUVH4howvJx80J+I/0=",
+      "dev": true
+    },
+    "http-proxy": {
+      "version": "1.17.0",
+      "resolved": "https://registry.npmjs.org/http-proxy/-/http-proxy-1.17.0.tgz",
+      "integrity": "sha512-Taqn+3nNvYRfJ3bGvKfBSRwy1v6eePlm3oc/aWVxZp57DQr5Eq3xhKJi7Z4hZpS8PC3H4qI+Yly5EmFacGuA/g==",
+      "dev": true,
+      "requires": {
+        "eventemitter3": "^3.0.0",
+        "follow-redirects": "^1.0.0",
+        "requires-port": "^1.0.0"
+      }
+    },
+    "http-server": {
+      "version": "0.11.1",
+      "resolved": "https://registry.npmjs.org/http-server/-/http-server-0.11.1.tgz",
+      "integrity": "sha512-6JeGDGoujJLmhjiRGlt8yK8Z9Kl0vnl/dQoQZlc4oeqaUoAKQg94NILLfrY3oWzSyFaQCVNTcKE5PZ3cH8VP9w==",
+      "dev": true,
+      "requires": {
+        "colors": "1.0.3",
+        "corser": "~2.0.0",
+        "ecstatic": "^3.0.0",
+        "http-proxy": "^1.8.1",
+        "opener": "~1.4.0",
+        "optimist": "0.6.x",
+        "portfinder": "^1.0.13",
+        "union": "~0.4.3"
+      },
+      "dependencies": {
+        "ecstatic": {
+          "version": "3.2.0",
+          "resolved": "https://registry.npmjs.org/ecstatic/-/ecstatic-3.2.0.tgz",
+          "integrity": "sha512-Goilx/2cfU9vvfQjgtNgc2VmJAD8CasQ6rZDqCd2u4Hsyd/qFET6nBf60jiHodevR3nl3IGzNKtrzPXWP88utQ==",
+          "dev": true,
+          "requires": {
+            "he": "^1.1.1",
+            "mime": "^1.4.1",
+            "minimist": "^1.1.0",
+            "url-join": "^2.0.2"
+          }
+        }
+      }
+    },
+    "mime": {
+      "version": "1.6.0",
+      "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz",
+      "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==",
+      "dev": true
+    },
+    "minimist": {
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz",
+      "integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=",
+      "dev": true
+    },
+    "mkdirp": {
+      "version": "0.5.1",
+      "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.1.tgz",
+      "integrity": "sha1-MAV0OOrGz3+MR2fzhkjWaX11yQM=",
+      "dev": true,
+      "requires": {
+        "minimist": "0.0.8"
+      },
+      "dependencies": {
+        "minimist": {
+          "version": "0.0.8",
+          "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.8.tgz",
+          "integrity": "sha1-hX/Kv8M5fSYluCKCYuhqp6ARsF0=",
+          "dev": true
+        }
+      }
+    },
+    "ms": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+      "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=",
+      "dev": true
+    },
+    "opener": {
+      "version": "1.4.3",
+      "resolved": "https://registry.npmjs.org/opener/-/opener-1.4.3.tgz",
+      "integrity": "sha1-XG2ixdflgx6P+jlklQ+NZnSskLg=",
+      "dev": true
+    },
+    "optimist": {
+      "version": "0.6.1",
+      "resolved": "https://registry.npmjs.org/optimist/-/optimist-0.6.1.tgz",
+      "integrity": "sha1-2j6nRob6IaGaERwybpDrFaAZZoY=",
+      "dev": true,
+      "requires": {
+        "minimist": "~0.0.1",
+        "wordwrap": "~0.0.2"
+      },
+      "dependencies": {
+        "minimist": {
+          "version": "0.0.10",
+          "resolved": "https://registry.npmjs.org/minimist/-/minimist-0.0.10.tgz",
+          "integrity": "sha1-3j+YVD2/lggr5IrRoMfNqDYwHc8=",
+          "dev": true
+        }
+      }
+    },
+    "portfinder": {
+      "version": "1.0.13",
+      "resolved": "https://registry.npmjs.org/portfinder/-/portfinder-1.0.13.tgz",
+      "integrity": "sha1-uzLs2HwnEErm7kS1o8y/Drsa7ek=",
+      "dev": true,
+      "requires": {
+        "async": "^1.5.2",
+        "debug": "^2.2.0",
+        "mkdirp": "0.5.x"
+      }
+    },
+    "qs": {
+      "version": "2.3.3",
+      "resolved": "https://registry.npmjs.org/qs/-/qs-2.3.3.tgz",
+      "integrity": "sha1-6eha2+ddoLvkyOBHaghikPhjtAQ=",
+      "dev": true
+    },
+    "requires-port": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/requires-port/-/requires-port-1.0.0.tgz",
+      "integrity": "sha1-kl0mAdOaxIXgkc8NpcbmlNw9yv8=",
+      "dev": true
+    },
+    "tslib": {
+      "version": "1.14.1",
+      "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz",
+      "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg=="
+    },
+    "union": {
+      "version": "0.4.6",
+      "resolved": "https://registry.npmjs.org/union/-/union-0.4.6.tgz",
+      "integrity": "sha1-GY+9rrolTniLDvy2MLwR8kopWeA=",
+      "dev": true,
+      "requires": {
+        "qs": "~2.3.3"
+      }
+    },
+    "url-join": {
+      "version": "2.0.5",
+      "resolved": "https://registry.npmjs.org/url-join/-/url-join-2.0.5.tgz",
+      "integrity": "sha1-WvIvGMBSoACkjXuCxenC4v7tpyg=",
+      "dev": true
+    },
+    "wordwrap": {
+      "version": "0.0.3",
+      "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-0.0.3.tgz",
+      "integrity": "sha1-o9XabNXAvAAI03I0u68b7WMFkQc=",
+      "dev": true
+    }
+  }
+}

package/demos/jsapi-integration/package.json ADDED Viewed

@@ -0,0 +1,19 @@
+{
+  "name": "@esri/jsapi-integration",
+  "version": "3.4.3",
+  "private": true,
+  "description": "to do",
+  "author": "",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@esri/arcgis-rest-auth": "^3.4.3",
+    "@esri/arcgis-rest-portal": "^3.4.3",
+    "@esri/arcgis-rest-request": "^3.4.3"
+  },
+  "devDependencies": {
+    "http-server": "*"
+  },
+  "scripts": {
+    "start": "http-server ."
+  }
+}

package/demos/node-cli-item-management/README.md ADDED Viewed

@@ -0,0 +1,10 @@
+# Node JS CLI Item Management
+Demo CLI application.
+## Running this demo
+1. Like all the other demo apps, run `npm run bootstrap` in the root directory.
+2. `cd demos/node-cli-item-management`
+3. `npm start`
+![CLI Screenshot](./screenshot.png)

package/demos/node-cli-item-management/index.js ADDED Viewed

@@ -0,0 +1,238 @@
+require('cross-fetch/polyfill');
+require("isomorphic-form-data");
+const prompts = require("prompts");
+const chalk = require("chalk");
+const { setDefaultRequestOptions } = require('@esri/arcgis-rest-request');
+const { UserSession } = require("@esri/arcgis-rest-auth");
+const {
+  searchItems,
+  removeItem,
+  SearchQueryBuilder
+} = require("@esri/arcgis-rest-portal");
+// 1. Promt the user for sign in. Create a `UserSession`
+authenticate()
+  .then(session => {
+    console.log(chalk.blue(`Signed in as ${session.username}`));
+    // once the user is signed in search for items
+    return searchForItems(session);
+  })
+  .then(({ response, session }) => {
+    console.log(chalk.blue(`Found ${response.results.length} items\n`));
+    // take the items that were found and prompt the user if they want to delete them
+    return deleteItems(response.results, session);
+  })
+  .then(() => {
+    console.log(chalk.blue(`Done!`));
+  });
+// Prompt the user for a `username` and `password` return a `UserSession`
+// This function will run again on any error so it will retry until it works
+function authenticate() {
+  const authPromtpts = [
+    {
+      type: "text",
+      name: "username",
+      message: "Username"
+    },
+    {
+      type: "password",
+      name: "password",
+      message: "Password"
+    }
+  ];
+  let session;
+  // prompts returns a `Promise` that resolves with the users input
+  return prompts(authPromtpts)
+    .then(({ username, password }) => {
+      session = new UserSession({
+        username,
+        password
+      });
+      // this will generate a token and use it to get into about a user
+      return session.getUser();
+    })
+    .then(self => {
+      return session;
+    })
+    .catch(error => {
+      // in case of an `ArcGISRequestError` assume the `username` and `password`
+      // are incorrect run the `authenticate` function again
+      if (error.name === "ArcGISRequestError") {
+        console.log(
+          chalk.bold.red("Incorrect username and/or password please try again")
+        );
+        return authenticate();
+      }
+      // if this is a different error just log the error message and exit
+      console.log(
+        `${chalk.bold.red(error.name)} ${chalk.bold.red(error.message)}`
+      );
+    });
+}
+// given a `UserSession` prompt the user for some search params and search for items
+function searchForItems(session) {
+  const searchPrompts = [
+    {
+      type: "text",
+      name: "searchText",
+      message: "Search Query"
+    },
+    {
+      type: "list",
+      name: "itemTypes",
+      message: "Item Types"
+    },
+    {
+      type: "list",
+      name: "itemTags",
+      message: "Tags"
+    },
+    {
+      type: "number",
+      name: "number",
+      message: "How Many?"
+    }
+  ];
+  // prompts returns a `Promise` that resolves with the users input
+  return prompts(searchPrompts).then(
+    //use ES2015 destructuring so we don't make any extra variables
+    ({ searchText, itemTypes, itemTags, number }) => {
+      const query = new SearchQueryBuilder()
+        .match(session.username)
+        .in("owner");
+      // format the search query for item types
+      const types = itemTypes.filter(type => type.length);
+      // format the search query for item types
+      if (types.length) {
+        query.and().startGroup();
+        types.forEach((type, index, types) => {
+          query.match(type).in("type");
+          if (index !== types.length - 1) {
+            query.or();
+          }
+        });
+        query.endGroup();
+      }
+      // format the search query for item tags
+      const tags = itemTags.filter(tag => tag.length);
+      if (tags.length) {
+        query.and().startGroup();
+        tags.forEach((tag, index, tags) => {
+          query.match(tag).in("tags");
+          if (index !== tags.length - 1) {
+            query.or();
+          }
+        });
+        query.endGroup();
+      }
+      // format the search query for the search text
+      if (searchText.length) {
+        query.and().match(searchText);
+      }
+      console.log(chalk.blue(`Searching ArcGIS Online: ${query.toParam()}`));
+      return searchItems({
+        authentication: session,
+        q: query,
+        num: number
+      })
+      .then(response => {
+        return { response, session };
+      })
+      .catch(err => {
+        console.warn(err);
+      })
+    }
+  );
+}
+// this give a list of `items` and a `UserSession` this will ask us 1 at a time
+// if we want to delte this item. This uses the new async iteration syntax with
+// `Symbol.asyncIterator` to perform an async function in a loop
+async function deleteItems(items, session) {
+  // create our iterator which should return a `Promise`
+  const asyncIterable = {
+    [Symbol.asyncIterator]: () => ({
+      // every time we ask for a new item
+      next: function() {
+        // remove the next item from the array
+        const item = items.pop();
+        // we are done if there is no item
+        if (!item) {
+          return Promise.resolve({ done: true });
+        }
+        // prompt to delete this item.
+        return deleteItem(item, session);
+      }
+    })
+  };
+  // lets get our `next` function so we can itterate over it
+  const { next } = asyncIterable[Symbol.asyncIterator]();
+  for (
+    let { done, deleted, item } = await next(); // start condition, call next and wait for the `Promise` to resolve, results are destructed.
+    !done; // end condition,
+    { done, deleted, item } = await next() // action on every loop, sets up the next round of checks
+  ) {
+    if (deleted) {
+      console.log(chalk.green(`${item.title} deleted successfuly\n`));
+    } else {
+      console.log(chalk.gray(`${item.title} skipped\n`));
+    }
+  }
+  // since this is inside an async function code execution is stopped at the loop
+  // this will return an empty resolved `Promise` when the loop is done.
+  return Promise.resolve();
+}
+function deleteItem(item, session) {
+  console.log(`Title:    ${chalk.bold.green(item.title)}`);
+  console.log(`Tags:     ${item.tags.join(", ")}`);
+  console.log(`Type:     ${item.type}`);
+  console.log(`ID:       ${item.id}`);
+  console.log(`Owner:    ${item.owner}`);
+  console.log(`Created:  ${new Date(item.created).toLocaleDateString("en")}`);
+  console.log(`Modified: ${new Date(item.modified).toLocaleDateString("en")}`);
+  const deleteQuestions = [
+    {
+      type: "toggle",
+      name: "del",
+      message: "Delete this item?",
+      initial: false,
+      active: "yes",
+      inactive: "no"
+    }
+  ];
+  return prompts(deleteQuestions).then(({ del }) => {
+    if (del) {
+      console.log(chalk.red.bold(`Deleting ${item.title}`));
+      return removeItem({
+        id: item.id,
+        authentication: session
+      }).then(() => {
+        return Promise.resolve({ done: false, deleted: del, item });
+      });
+    }
+    return Promise.resolve({ done: false, deleted: del, item });
+  });
+}