etincidunt 1.0.0

package/packages/arcgis-rest-items/test/mocks/item.ts

@@ -0,0 +1,30 @@
+import { IItem } from "@esri/arcgis-rest-common-types";
+
+export const ItemSuccessResponse: any = {
+  success: true,
+  id: "3efakeitemid0000"
+};
+
+export const ItemResponse: IItem = {
+  id: "4bc",
+  owner: "jeffvader",
+  title: "DS Plans",
+  description: "The plans",
+  snippet: "Yeah these are the ones",
+  tags: ["plans", "star dust"],
+  type: "Web Map",
+  typeKeywords: ["Javascript", "hubSiteApplication"],
+  properties: {
+    parentId: "3eb"
+  },
+  created: 123,
+  modified: 456,
+  protected: false
+};
+
+export const ItemDataResponse: any = {
+  source: "3ef",
+  values: {
+    key: "value"
+  }
+};

package/packages/arcgis-rest-items/test/mocks/resources.ts

@@ -0,0 +1,28 @@
+export const GetItemResourcesResponse: any = {
+  total: 3,
+  start: 1,
+  num: 3,
+  nextStart: -1,
+  resources: [
+    {
+      resource: "image/banner.jpg"
+    },
+    {
+      resource: "image/logo.jpg"
+    },
+    {
+      resource: "text/desc.txt"
+    }
+  ]
+};
+
+export const RemoveItemResourceResponse: any = {
+  success: true
+};
+
+export const UpdateItemResourceResponse: any = {
+  success: true,
+  itemId: "0c66beb52dff4994be67937cdadbdbf1",
+  owner: "jsmith",
+  folder: null
+};

package/packages/arcgis-rest-items/test/mocks/search.ts

@@ -0,0 +1,60 @@
+import { ISearchResult } from "../../src/items";
+
+export const SearchResponse: ISearchResult = {
+  query: "",
+  total: 10795,
+  start: 1,
+  num: 1,
+  nextStart: 2,
+  results: [
+    {
+      id: "a5b",
+      owner: "dcadminqa",
+      created: 1496748288000,
+      modified: 1508856526000,
+      name: "survey123_7d7a9fabcb0c44bcaf1d6473cd088a07",
+      title: " Drug Activity Reporter",
+      type: "Feature Service",
+      typeKeywords: [
+        "ArcGIS Server",
+        "Data",
+        "Feature Access",
+        "Feature Service",
+        "OwnerView",
+        "Service",
+        "Survey123",
+        "Survey123 Hub",
+        "Hosted Service"
+      ],
+      description: "Some Description",
+      tags: [],
+      snippet: "Some Snippet",
+      thumbnail: "thumbnail/ago_downloaded.png",
+      documentation: "WAT docs",
+      extent: [[-180, -90], [180, 90]],
+      categories: [],
+      spatialReference: null,
+      accessInformation: null,
+      licenseInfo: null,
+      culture: null,
+      properties: {},
+      url:
+        "https://servicesqa.arcgis.com/97KLIFOSt5CxbiRI/arcgis/rest/services/survey123_7d7a9fabcb0c44bcaf1d6473cd088a07/FeatureServer",
+      proxyFilter: null,
+      access: "shared",
+      size: -1,
+      appCategories: [],
+      industries: [],
+      languages: [],
+      largeThumbnail: null,
+      banner: null,
+      screenshots: [],
+      listed: false,
+      numComments: 0,
+      numRatings: 0,
+      avgRating: 0,
+      numViews: 4,
+      protected: false
+    }
+  ]
+};

package/packages/arcgis-rest-items/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": [
+      "src/**/*.ts"
+  ]
+}

package/packages/arcgis-rest-request/README.md

@@ -0,0 +1,65 @@
+[![npm version][npm-img]][npm-url]
+[![build status][travis-img]][travis-url]
+[![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/arcgis-rest-js/master/LICENSE)
+
+[npm-img]: https://img.shields.io/npm/v/@esri/arcgis-rest-request.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-request
+[travis-img]: https://img.shields.io/travis/Esri/arcgis-rest-js/master.svg?style=flat-square
+[travis-url]: https://travis-ci.org/Esri/arcgis-rest-js
+
+# @esri/arcgis-rest-request
+
+> A module for making requests to the ArcGIS REST API that runs in Node.js and modern browsers.
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+```
+
+```js
+import { request } from '@esri/arcgis-rest-request';
+
+const url = "https://www.arcgis.com/sharing/rest/content/items/6e03e8c26aad4b9c92a87c1063ddb0e3/data";
+
+request(url)
+    .then(response => {
+        console.log(response) // WebMap JSON
+    });
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/request/)
+
+### Issues
+
+If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first.  Have you found a new bug?  Want to request a new feature?  We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you.
+
+If you're looking for help you can also post issues on [GIS Stackexchange](http://gis.stackexchange.com/questions/ask?tags=esri-oss).
+
+### Versioning
+
+For transparency into the release cycle and in striving to maintain backward compatibility, @esri/arcgis-rest-js is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible.
+
+For more information on SemVer, please visit <http://semver.org/>.
+
+### Contributing
+
+Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](CONTRIBUTING.md).
+
+### License
+
+Copyright &copy; 2017-2018 Esri
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+> http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+A copy of the license is available in the repository's [LICENSE](../../LICENSE) file.

package/packages/arcgis-rest-request/package-lock.json

@@ -0,0 +1,11 @@
+{
+	"requires": true,
+	"lockfileVersion": 1,
+	"dependencies": {
+		"tslib": {
+			"version": "1.7.1",
+			"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.7.1.tgz",
+			"integrity": "sha1-vIAEFkaRkjp5/oN4u+s9ogF1OOw="
+		}
+	}
+}

package/packages/arcgis-rest-request/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@esri/arcgis-rest-request",
+  "version": "1.6.0",
+  "description": "Common methods and utilities for @esri/arcgis-rest-* packages.",
+  "main": "dist/node/index.js",
+  "browser": "dist/umd/request.umd.js",
+  "module": "dist/esm/index.js",
+  "js:next": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "tslib": "^1.7.1"
+  },
+  "files": [
+    "dist/**"
+  ],
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "npm run build:node && npm run build:umd && npm run build:esm",
+    "build:esm": "tsc --module es2015 --outDir ./dist/esm --declaration",
+    "build:umd": "rollup -c ../../umd-base-profile.js && rollup -c ../../umd-production-profile.js",
+    "build:node": "tsc --module commonjs --outDir ./dist/node"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Esri/arcgis-rest-js.git"
+  },
+  "contributors": [
+    {
+      "name": "Patrick Arlt",
+      "email": "parlt@esri.com",
+      "url": "http://patrickarlt.com/"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "homepage": "https://github.com/Esri/arcgis-rest-js#readme"
+}

package/packages/arcgis-rest-request/src/index.ts

@@ -0,0 +1,10 @@
+export * from "./request";
+export * from "./utils/encode-form-data";
+export * from "./utils/encode-query-string";
+export * from "./utils/check-for-errors";
+export * from "./utils/ArcGISRequestError";
+export * from "./utils/ArcGISAuthError";
+export * from "./utils/ErrorTypes";
+export * from "./utils/process-params";
+export * from "./utils/get-portal";
+export * from "./utils/get-portal-url";

package/packages/arcgis-rest-request/src/request.ts

@@ -0,0 +1,259 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { checkForErrors } from "./utils/check-for-errors";
+import { encodeFormData } from "./utils/encode-form-data";
+import { encodeQueryString } from "./utils/encode-query-string";
+import { requiresFormData } from "./utils/process-params";
+import { ArcGISRequestError } from "./utils/ArcGISRequestError";
+
+/**
+ * Authentication can be supplied to `request` via [`UserSession`](../../auth/UserSession/) or [`ApplicationSession`](../../auth/ApplicationSession/). Both classes extend `IAuthenticationManager`.
+ * ```js
+ * const session = new UserSession({
+ *   username: "jsmith",
+ *   password: "123456",
+ *   // optional
+ *   portal: "https://[yourserver]/arcgis/sharing/rest"
+ * })
+ *
+ * request(url, { authentication: session })
+ * ```
+ */
+export interface IAuthenticationManager {
+  /**
+   * Defaults to 'https://www.arcgis.com/sharing/rest'.
+   */
+  portal: string;
+  getToken(url: string): Promise<string>;
+}
+
+/**
+ * HTTP methods used by the ArcGIS REST API.
+ */
+export type HTTPMethods = "GET" | "POST";
+
+/**
+ * Valid response formats for the `f` parameter.
+ */
+export type ResponseFormats =
+  | "json"
+  | "geojson"
+  | "text"
+  | "html"
+  | "image"
+  | "zip";
+
+export interface IParams {
+  f?: ResponseFormats;
+  [key: string]: any;
+}
+
+/**
+ * Options for the `request()` method.
+ */
+export interface IRequestOptions {
+  /**
+   * Additional parameters to pass in the request.
+   */
+  params?: IParams;
+
+  /**
+   * The HTTP method to send the request with.
+   */
+  httpMethod?: HTTPMethods;
+
+  /**
+   * The instance of `IAuthenticationManager` to use to authenticate this request.
+   */
+  authentication?: IAuthenticationManager;
+
+  /**
+   * Base url for the portal you want to make the request to. Defaults to 'https://www.arcgis.com/sharing/rest'.
+   */
+  portal?: string;
+
+  /**
+   * The implementation of `fetch` to use. Defaults to a global `fetch`.
+   */
+  fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+
+  /**
+   * If the length of a GET request's URL exceeds `maxUrlLength` the request will use POST instead.
+   */
+  maxUrlLength?: number;
+}
+
+/**
+ * Generic method for making HTTP requests to ArcGIS REST API endpoints.
+ *
+ * ```js
+ * import { request } from '@esri/arcgis-rest-request';
+ *
+ * request('https://www.arcgis.com/sharing/rest')
+ *   .then((response) => {
+ *     console.log(response.currentVersion); // => 5.2
+ *   });
+ * ```
+ *
+ * ```js
+ * import { request, HTTPMethods } from '@esri/arcgis-rest-request';
+ *
+ * request('https://www.arcgis.com/sharing/rest', {
+ *   httpMethod: "GET"
+ * }).then((response) => {
+ *   console.log(response.currentVersion); // => 5.2
+ * });
+ * ```
+ *
+ * ```js
+ * import { request, HTTPMethods } from '@esri/arcgis-rest-request';
+ *
+ * request('https://www.arcgis.com/sharing/rest/search', {
+ *   params: { q: 'parks' }
+ * }).then((response) => {
+ *   console.log(response.total); // => 78379
+ * });
+ * ```
+ *
+ * @param url - The URL of the ArcGIS REST API endpoint.
+ * @param requestOptions - Options for the request, including parameters relevant to the endpoint.
+ * @returns A Promise that will resolve with the data from the response.
+ */
+export function request(
+  url: string,
+  requestOptions: IRequestOptions = { params: { f: "json" } }
+): Promise<any> {
+  const options: IRequestOptions = {
+    httpMethod: "POST",
+    fetch,
+    ...requestOptions
+  };
+
+  const missingGlobals: string[] = [];
+  const recommendedPackages: string[] = [];
+
+  if (!options.fetch) {
+    missingGlobals.push("`fetch`");
+    recommendedPackages.push("`isomorphic-fetch`");
+  }
+
+  if (!Promise) {
+    missingGlobals.push("`Promise`");
+    recommendedPackages.push("`es6-promise`");
+  }
+
+  if (!FormData) {
+    missingGlobals.push("`FormData`");
+    recommendedPackages.push("`isomorphic-form-data`");
+  }
+
+  if (!options.fetch || !Promise || !FormData) {
+    throw new Error(
+      `\`arcgis-rest-request\` requires global variables for \`fetch\`, \`Promise\` and \`FormData\` to be present in the global scope. You are missing ${missingGlobals.join(
+        ", "
+      )}. We recommend installing the ${recommendedPackages.join(
+        ", "
+      )} modules at the root of your application to add these to the global scope. See https://bit.ly/2KNwWaJ for more info.`
+    );
+  }
+
+  if (options.fetch === fetch) {
+    options.fetch = fetch.bind(Function("return this")());
+  }
+
+  const { httpMethod, authentication } = options;
+
+  const params: IParams = {
+    ...{ f: "json" },
+    ...requestOptions.params
+  };
+
+  const fetchOptions: RequestInit = {
+    method: httpMethod,
+    // ensures behavior mimics XMLHttpRequest. needed to support sending IWA cookies
+    credentials: "same-origin"
+  };
+
+  return (authentication ? authentication.getToken(url) : Promise.resolve(""))
+    .then(token => {
+      if (token.length) {
+        params.token = token;
+      }
+
+      if (fetchOptions.method === "GET") {
+        // encode the parameters into the query string
+        const queryParams = encodeQueryString(params);
+        // dont append a '?' unless parameters are actually present
+        const urlWithQueryString =
+          queryParams === "" ? url : url + "?" + encodeQueryString(params);
+
+        if (
+          options.maxUrlLength &&
+          urlWithQueryString.length > options.maxUrlLength
+        ) {
+          // the consumer specified a maximum length for URLs
+          // and this would exceed it, so use post instead
+          fetchOptions.method = "POST";
+        } else {
+          // just use GET
+          url = urlWithQueryString;
+        }
+      }
+
+      if (fetchOptions.method === "POST") {
+        fetchOptions.body = encodeFormData(params);
+      }
+
+      /* istanbul ignore else blob responses are difficult to make cross platform we will just have to trust the isomorphic fetch will do its job */
+      if (!requiresFormData(params)) {
+        fetchOptions.headers = new Headers();
+        fetchOptions.headers.append(
+          "Content-Type",
+          "application/x-www-form-urlencoded"
+        );
+      }
+
+      return options.fetch(url, fetchOptions);
+    })
+    .then(response => {
+      if (!response.ok) {
+        // server responded w/ an actual error (404, 500, etc)
+        const { status, statusText } = response;
+        throw new ArcGISRequestError(
+          statusText,
+          `HTTP ${status}`,
+          response,
+          url,
+          options
+        );
+      }
+      switch (params.f) {
+        case "json":
+          return response.json();
+        case "geojson":
+          return response.json();
+        case "html":
+          return response.text();
+        case "text":
+          return response.text();
+        /* istanbul ignore next blob responses are difficult to make cross platform we will just have to trust the isomorphic fetch will do its job */
+        case "image":
+          return response.blob();
+        /* istanbul ignore next */
+        case "zip":
+          return response.blob();
+        /* istanbul ignore next */
+        default:
+          // hopefully we never need to handle JSON payloads when no f= parameter is set
+          return response.blob();
+      }
+    })
+    .then(data => {
+      if (params.f === "json" || params.f === "geojson") {
+        return checkForErrors(data, url, params, options);
+      } else {
+        return data;
+      }
+    });
+}

package/packages/arcgis-rest-request/src/utils/ArcGISAuthError.ts

@@ -0,0 +1,67 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, IRequestOptions, IAuthenticationManager } from "../request";
+import { ArcGISRequestError } from "./ArcGISRequestError";
+
+export type IRetryAuthError = (
+  url: string,
+  options: IRequestOptions
+) => Promise<IAuthenticationManager>;
+
+export class ArcGISAuthError extends ArcGISRequestError {
+  /**
+   * Create a new `ArcGISAuthError`  object.
+   *
+   * @param message - The error message from the API
+   * @param code - The error code from the API
+   * @param response - The original response from the API that caused the error
+   * @param url - The original url of the request
+   * @param options - The original options of the request
+   */
+  constructor(
+    message = "AUTHENTICATION_ERROR",
+    code: string | number = "AUTHENTICATION_ERROR_CODE",
+    response?: any,
+    url?: string,
+    options?: IRequestOptions
+  ) {
+    super(message, code, response, url, options);
+    this.name = "ArcGISAuthError";
+    this.message =
+      code === "AUTHENTICATION_ERROR_CODE" ? message : `${code}: ${message}`;
+  }
+
+  retry(getSession: IRetryAuthError, retryLimit = 3) {
+    let tries = 0;
+
+    const retryRequest = (resolve: any, reject: any) => {
+      getSession(this.url, this.options)
+        .then(session => {
+          const newOptions = {
+            ...this.options,
+            ...{ authentication: session }
+          };
+
+          tries = tries + 1;
+          return request(this.url, newOptions);
+        })
+        .then(response => {
+          resolve(response);
+        })
+        .catch(e => {
+          if (e.name === "ArcGISAuthError" && tries < retryLimit) {
+            retryRequest(resolve, reject);
+          } else if (e.name === "ArcGISAuthError" && tries >= retryLimit) {
+            reject(this);
+          } else {
+            reject(e);
+          }
+        });
+    };
+
+    return new Promise((resolve, reject) => {
+      retryRequest(resolve, reject);
+    });
+  }
+}

package/packages/arcgis-rest-request/src/utils/ArcGISRequestError.ts

@@ -0,0 +1,73 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IRequestOptions } from "../request";
+
+// TypeScript 2.1 no longer allows you to extend built in types. See https://github.com/Microsoft/TypeScript/issues/12790#issuecomment-265981442
+// and https://github.com/Microsoft/TypeScript-wiki/blob/master/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work
+//
+// This code is from MDN https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error#Custom_Error_Types.
+export class ArcGISRequestError {
+  /**
+   * The name of this error. Will always be `"ArcGISRequestError"` to conform with the [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) class.
+   */
+  name: string;
+
+  /**
+   * Formatted error message. See the [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) class for more details.
+   */
+  message: string;
+
+  /**
+   * The errror message return from the request.
+   */
+  originalMessage: string;
+
+  /**
+   * The error code returned from the request.
+   */
+  code: string | number;
+
+  /**
+   * The original JSON response the caused the error.
+   */
+  response: any;
+
+  /**
+   * The URL of the original request that caused the error
+   */
+  url: string;
+
+  /**
+   * The options of the original request that caused the error
+   */
+  options: IRequestOptions;
+
+  /**
+   * Create a new `ArcGISRequestError`  object.
+   *
+   * @param message - The error message from the API
+   * @param code - The error code from the API
+   * @param response - The original response from the API that caused the error
+   * @param url - The original url of the request
+   * @param options - The original options and parameters of the request
+   */
+  constructor(
+    message = "UNKNOWN_ERROR",
+    code: string | number = "UNKNOWN_ERROR_CODE",
+    response?: any,
+    url?: string,
+    options?: IRequestOptions
+  ) {
+    this.name = "ArcGISRequestError";
+    this.message =
+      code === "UNKNOWN_ERROR_CODE" ? message : `${code}: ${message}`;
+    this.originalMessage = message;
+    this.code = code;
+    this.response = response;
+    this.url = url;
+    this.options = options;
+  }
+}
+ArcGISRequestError.prototype = Object.create(Error.prototype);
+ArcGISRequestError.prototype.constructor = ArcGISRequestError;

package/packages/arcgis-rest-request/src/utils/ErrorTypes.ts

@@ -0,0 +1,29 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+/**
+ * Enum describing the different errors that might be thrown by a request.
+ *
+ * ```ts
+ * import { request, ErrorTypes } from '@esri/arcgis-rest-request';
+ *
+ * request("...").catch((e) => {
+ *   switch(e.name) {
+ *     case ErrorType.ArcGISRequestError:
+ *     // handle a general error from the API
+ *     break;
+ *
+ *     case ErrorType.ArcGISAuthError:
+ *     // handle an authentication error
+ *     break;
+ *
+ *     default:
+ *     // handle some other error (usually a network error)
+ *   }
+ * });
+ * ```
+ */
+export enum ErrorTypes {
+  ArcGISRequestError = "ArcGISRequestError",
+  ArcGISAuthError = "ArcGISAuthError"
+}