autnam 1.0.0

package/.env.example

@@ -0,0 +1,2 @@
+UNIT_TESTING_API_KEY=
+GEOENRICHMENTSERVER_URL=""

package/.eslintrc.json

@@ -0,0 +1,37 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2018,
+    "sourceType": "module"
+  },
+  "env": {
+    "browser": true,
+    "node": true,
+    "es2017": true
+  },
+  "plugins": ["@typescript-eslint", "import"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    "prettier/@typescript-eslint",
+    "plugin:import/recommended",
+    "plugin:import/typescript"
+  ],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-unused-vars": "off",
+    "@typescript-eslint/ban-types": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "import/extensions": ["error", "ignorePackages"],
+
+    // remove import/no-unresolved once https://github.com/import-js/eslint-plugin-import/issues/2111 is resolved
+    "import/no-unresolved": "off"
+  },
+  "settings": {
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts", ".tsx"]
+    }
+  }
+}

package/.github/workflows/deploy-docs.yml

@@ -0,0 +1,27 @@
+name: Deploy Documentation
+# After a push to master, redeploy the docs
+on:
+  push:
+    branches: [master]
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "12.x"
+
+      - name: NPM Install
+        run: npm install
+
+      - name: Build Docs
+        run: npm run docs:build
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@4.1.4
+        with:
+          branch: gh-pages # The branch the action should deploy to.
+          folder: docs/build/arcgis-rest-js # The folder the action should deploy.

package/.github/workflows/pre-release-tests.yml

@@ -0,0 +1,49 @@
+name: Pre-Release Tests
+
+# On pushes to master (i.e. merging a PR)
+# run all tests, on win, macos, linux, on node 12 & 14
+on:
+  push:
+    branches:
+      - master
+    # Dont run if it's just markdown or doc files
+    paths-ignore:
+      - "**.md"
+      - "docs/**"
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        node: [12, 14, 16]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Upgrade npm
+        run: npm i -g npm@7
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Test in Node
+        run: npm run test:node
+
+      - name: Test in Chrome
+        run: npm run test:chrome:ci
+
+      - uses: codecov/codecov-action@v1
+        with:
+          directory: ./coverage

package/.github/workflows/pull-request-tests.yml

@@ -0,0 +1,49 @@
+name: PR Tests
+
+# Only run on non-draft PRs, and when PRs are synched
+on:
+  pull_request:
+    types: [opened, reopened, ready_for_review, synchronize]
+    # If the PR has other files, a push w/ just .md or /docs
+    # files will still cause tests to run
+    paths-ignore:
+      - "**.md"
+      - "docs/**"
+jobs:
+  build:
+    if: github.event.pull_request.draft == false
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        node: [12, 14, 16]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Update to NPM 7 for workspace support
+        run: npm install -g npm@7
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Build
+        run: npm run build
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Test in Node
+        run: npm run test:node
+
+      - name: Test in Chrome
+        run: npm run test:chrome:ci
+
+      - uses: codecov/codecov-action@v1
+        with:
+          directory: ./coverage

package/.github/workflows/release.yml

@@ -0,0 +1,75 @@
+name: Build, Test, Release
+
+# On pushes to master (i.e. merging a PR)
+# run all tests, on win, macos, linux, on node 12 & 14
+on:
+  push:
+    branches:
+      # UMCOMMENT BEFORE WE MERGE BETA -> MASTER
+      # - master -
+      - beta
+    # Dont run if it's just markdown or doc files
+    paths-ignore:
+      - "**.md"
+      - "docs/**"
+
+jobs:
+  # First, build and test on multiple os's
+  # and multuple versions of node
+  build_and_test:
+    name: Build and Test
+
+    runs-on: ${{ matrix.os }}
+
+    # PRs will run tests on node 14,16 on ubuntu, macos and windows
+    # so for the release, we're just running node 16@ubuntu
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [16]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Test in Chrome
+        run: npm run test:chrome:ci
+
+      - name: Test in Node
+        run: npm run test:node
+
+      - uses: codecov/codecov-action@v1
+        with:
+          directory: ./coverage
+
+  # If the build and test works, run a release
+  release:
+    name: Release
+    needs: [build_and_test]
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16.13
+
+      - name: Install
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm run release

package/.prettierignore

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

package/.prettierrc

@@ -0,0 +1,19 @@
+{
+  "arrowParens": "always",
+  "bracketSpacing": true,
+  "endOfLine": "lf",
+  "htmlWhitespaceSensitivity": "css",
+  "insertPragma": false,
+  "jsxBracketSameLine": false,
+  "jsxSingleQuote": false,
+  "printWidth": 80,
+  "proseWrap": "preserve",
+  "quoteProps": "as-needed",
+  "requirePragma": false,
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "none",
+  "useTabs": false,
+  "vueIndentScriptAndStyle": false
+}

package/.vscode/launch.json

@@ -0,0 +1,25 @@
+{
+  // 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": [
+    {
+      "name": "Attach to `npm run test:node:debug`",
+      "type": "node",
+      "request": "attach",
+      "port": 9229
+    },
+    {
+      "type": "pwa-msedge",
+      "request": "attach",
+      "name": "Attach to `npm run test:chrome:debug`",
+      "address": "localhost",
+      "port": 9333,
+      "pathMapping": {
+        "/": "${workspaceRoot}/",
+        "/base/": "${workspaceRoot}/"
+      }
+    }
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "editor.tabSize": 2,
+    "javascript.preferences.importModuleSpecifierEnding": "js",
+    "typescript.preferences.importModuleSpecifierEnding": "js"
+}

package/codecov.yml

@@ -0,0 +1,7 @@
+codecov:
+  require_ci_to_pass: yes
+
+coverage:
+  round: up
+  range: 90..95
+  precision: 2

package/commitlint.config.cjs

@@ -0,0 +1,41 @@
+
+
+const Configuration = {
+  /*
+   * Resolve and load @commitlint/config-conventional from node_modules.
+   * Referenced packages must be installed
+   */
+  extends: ['@commitlint/config-lerna-scopes', '@commitlint/config-conventional'],
+  /*
+   * Resolve and load conventional-changelog-atom from node_modules.
+   * Referenced packages must be installed
+   */
+  // parserPreset: 'conventional-changelog-atom',
+  /*
+   * Resolve and load @commitlint/format from node_modules.
+   * Referenced package must be installed
+   */
+  formatter: '@commitlint/format',
+  /*
+   * Any rules defined here will override rules from @commitlint/config-conventional
+   */
+  rules: {
+    'type-enum': [2, 'always', 
+    ['build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test']],
+  },
+  /*
+   * Functions that return true if commitlint should ignore the given message.
+   */
+  ignores: [
+    // empty commit messages
+    (commit) => commit === '', 
+    // pr feedback
+    (commit) => /^PR:/i.test(commit)
+  ],
+  /*
+   * Whether commitlint uses the default ignore rules.
+   */
+  defaultIgnores: true,
+};
+
+module.exports = Configuration;

package/demos/.eslintrc.js

@@ -0,0 +1,13 @@
+/* eslint-env node */
+module.exports = {
+    root: true,
+    env: {
+      node: true,
+      browser: true,
+      es6: true
+    },
+    extends: [
+      'eslint:recommended',
+      'prettier',
+    ]
+  };

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

@@ -0,0 +1,30 @@
+# 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 build` 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,31 @@
+#!/usr/bin/env node
+
+/**
+ * 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) {
+    console.log(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,32 @@
+/**
+ * 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({
+      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.json

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

package/demos/attachments-browser/README.md

@@ -0,0 +1,7 @@
+# Running this demo
+
+1. Make sure you run `npm run build` in the root folder to setup the dependencies
+1. `npm start`
+1. Visit 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.