npm - autculpa - Versions diffs - 1.0.0 - Mend

autculpa 1.0.0

Files changed (489) hide show

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

@@ -0,0 +1,91 @@
+<!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="config.js"></script>
+    <script src="@esri/arcgis-rest-request/dist/bundled/request.umd.js"></script>
+    <script src="@esri/arcgis-rest-portal/dist/bundled/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
+      const redirect_uri = window.location.origin + window.location.pathname + "authenticate.html";
+      arcgisRest.UserSession.beginOAuth2({
+          clientId: clientId,
+          redirectUri: redirect_uri,
+          popup: true
+      }).then(session => {
+        // Next, fetch a private item's data (not just the metadata)
+        //
+        // Change this to an itemId of a private webmap that you have access too.
+        const itemId = "75f08b51fa714d9c863aaf002dfba0c6";
+        return 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 if you have credentials in teh JS API IdentityManager class
+          esriId.getCredential("https://arcgis.com/sharing/rest/")
+            .then(cred => {
+              const session2 = arcgisRest.UserSession.fromCredential(cred);
+            });
+        });
+      });
+    </script>
+  </body>
+</html>

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

@@ -0,0 +1,15 @@
+{
+  "private": true,
+  "name": "@esri/jsapi-integration",
+  "version": "3.3.0",
+  "description": "to do",
+  "license": "Apache-2.0",
+  "scripts": {
+    "start": "node ../../scripts/run-demo-server.js"
+  },
+  "dependencies": {
+    "@esri/arcgis-rest-portal": "^3.3.0",
+    "@esri/arcgis-rest-request": "^3.3.0"
+  },
+  "author": ""
+}

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

@@ -0,0 +1,11 @@
+# Node JS CLI Item Management
+Demo CLI application.
+## Running this demo
+1. Like other demo apps, run `npm run build` 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,229 @@
+const prompts = require("prompts");
+const chalk = require("chalk");
+const { UserSession } = require("@esri/arcgis-rest-request");
+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 }) => {
+      return UserSession.signIn({
+        username,
+        password
+      });
+    })
+    .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 });
+  });
+}

package/demos/node-cli-item-management/package.json ADDED Viewed

@@ -0,0 +1,24 @@
+{
+  "private": true,
+  "name": "cli-item-management",
+  "version": "3.3.0",
+  "description": "Manage items in ArcGIS Online with a Node JS CLI and ArcGIS Rest JS",
+  "license": "Apache-2.0",
+  "keywords": [
+    "arcgis",
+    "arcgis-rest-js",
+    "node"
+  ],
+  "main": "index.js",
+  "scripts": {
+    "start": "node index.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@esri/arcgis-rest-portal": "^3.3.0",
+    "@esri/arcgis-rest-request": "^3.3.0",
+    "chalk": "^2.3.0",
+    "prompts": "^2.0.3"
+  },
+  "author": "Patrick Arlt <parlt@esri.com>"
+}

package/demos/node-cli-item-management/screenshot.png ADDED Viewed

Binary file

package/demos/node-common-js/README.md ADDED Viewed

@@ -0,0 +1,4 @@
+# Common JS Modules in Node.js
+1. Run `npm run build` in the root directory
+1. Run `npm start` to make a require and log output.

package/demos/node-common-js/index.js ADDED Viewed

@@ -0,0 +1,5 @@
+const { request } = require("@esri/arcgis-rest-request");
+request("https://www.arcgis.com/sharing/rest/info", {}).then((response) => {
+  console.log(response);
+});

package/demos/node-common-js/package.json ADDED Viewed

@@ -0,0 +1,15 @@
+{
+  "private": true,
+  "name": "arcgis-rest-js-node-common-js-integration-test",
+  "version": "1.0.0",
+  "description": "",
+  "license": "Apache-2.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@esri/arcgis-rest-request": "^3.3.0"
+  },
+  "author": ""
+}

package/demos/node-es-modules/README.md ADDED Viewed

@@ -0,0 +1,4 @@
+# Native JavaScript Modules in Node.js
+1. Run `npm run build` in the root directory
+1. Run `npm start` to make a require and log output.

package/demos/node-es-modules/index.js ADDED Viewed

@@ -0,0 +1,5 @@
+import { request } from "@esri/arcgis-rest-request";
+request("https://www.arcgis.com/sharing/rest/info", {}).then((response) => {
+  console.log(response);
+});

package/demos/node-es-modules/package.json ADDED Viewed

@@ -0,0 +1,16 @@
+{
+  "private": true,
+  "name": "arcgis-rest-js-node-es-modules-integration-test",
+  "version": "1.0.0",
+  "description": "",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@esri/arcgis-rest-request": "^3.3.0"
+  },
+  "author": ""
+}

package/demos/oauth2-browser/README.md ADDED Viewed

@@ -0,0 +1,17 @@
+# ArcGIS Rest JS / Vanilla JS Demo
+This demo uses Vanilla JS to implement OAuth2 using
+the `arcgis-rest-js` libraries.
+See the ArcGIS Rest JS guide to [Authentication in Browser-based Apps](https://esri.github.io/arcgis-rest-js/guides/browser-authentication/) for more info.
+## Running this demo
+1. Run `npm run build` in the root directory
+1. Register a new application using https://developers.arcgis.com/applications/new (you will be prompted to sign in or create a free account first).
+1. Add a redirect URL of `http://localhost:8080/authenticate.html` to your new app.
+1. Either copy the `config.js.template` file and rename it to `config.js` with your own ClientID or supply it in the prompt when the app is launched.
+1. Run `npm start` to spin up the development server.
+1. Visit [http://localhost:8080](http://localhost:8080).
+**Note:** The server starts with a special configuration to serve URLs starting with `@esri/arcgis-rest-*` from their respective packages. In your application you will need to change these URLs to point to their respective locations.

package/demos/oauth2-browser/authenticate.html ADDED Viewed

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>ArcGIS Rest JS OAuth redirect</title>
+  </head>
+  <body>
+    <script src="@esri/arcgis-rest-request/dist/bundled/request.umd.js"></script>
+    <script>
+      /* in a production app, clientId could be hardcoded. here we're using a regex to extract it from the state parameter in the OAuth2 server response to make the demo more interchangeable.
+      this relies on the fact that the ClientId is associated with the state parameter internally when another value isn't supplied manually.
+      */
+      const match = window.location.href.match(
+        /&state=([^&]+)/
+      );
+      const clientId = match[1];
+      let session;
+      function processAuthentication() {
+        window.location.href = './';
+        session = arcgisRest.UserSession.completeOAuth2({
+          clientId: clientId,
+        });
+        localStorage.setItem('__ARCGIS_REST_USER_SESSION__', session.serialize());
+      }
+      processAuthentication();
+    </script>
+  </body>
+</html>

package/demos/oauth2-browser/config.js.template 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 = "QVQNb3XfDzoboWS0"