culparepellendus 1.0.0

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

@@ -0,0 +1,10 @@
+/**
+ * Valid response formats for the `f` parameter.
+ */
+export type ResponseFormats =
+  | "json"
+  | "geojson"
+  | "text"
+  | "html"
+  | "image"
+  | "zip";

package/packages/arcgis-rest-request/src/utils/append-custom-params.ts

@@ -0,0 +1,49 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IRequestOptions } from "./IRequestOptions";
+
+/**
+ * Helper for methods with lots of first order request options to pass through as request parameters.
+ */
+export function appendCustomParams<T extends IRequestOptions>(
+  customOptions: T,
+  keys: Array<keyof T>,
+  baseOptions?: Partial<T>
+): IRequestOptions {
+  const requestOptionsKeys = [
+    "params",
+    "httpMethod",
+    "rawResponse",
+    "authentication",
+    "portal",
+    "fetch",
+    "maxUrlLength",
+    "headers"
+  ];
+
+  const options: T = {
+    ...{ params: {} },
+    ...baseOptions,
+    ...customOptions
+  };
+
+  // merge all keys in customOptions into options.params
+  options.params = keys.reduce((value, key) => {
+    if (customOptions[key] || typeof customOptions[key] === "boolean") {
+      value[key as any] = customOptions[key];
+    }
+    return value;
+  }, options.params);
+
+  // now remove all properties in options that don't exist in IRequestOptions
+  return requestOptionsKeys.reduce(
+    (value, key) => {
+      if ((options as any)[key]) {
+        (value as any)[key] = (options as any)[key];
+      }
+      return value;
+    },
+    {} as IRequestOptions
+  );
+}

package/packages/arcgis-rest-request/src/utils/clean-url.ts

@@ -0,0 +1,20 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+/**
+ * Helper method to ensure that user supplied urls don't include whitespace or a trailing slash.
+ */
+export function cleanUrl(url: string) {
+  // Guard so we don't try to trim something that's not a string
+  if (typeof url !== "string") {
+    return url;
+  }
+  // trim leading and trailing spaces, but not spaces inside the url
+  url = url.trim();
+
+  // remove the trailing slash to the url if one was included
+  if (url[url.length - 1] === "/") {
+    url = url.slice(0, -1);
+  }
+  return url;
+}

package/packages/arcgis-rest-request/src/utils/decode-query-string.ts

@@ -0,0 +1,27 @@
+/* Copyright (c) 2017-2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export function decodeParam(param: string): { key: string; value: string } {
+  const [key, value] = param.split("=");
+  return { key: decodeURIComponent(key), value: decodeURIComponent(value) };
+}
+
+/**
+ * Decodes the passed query string as an object.
+ *
+ * @param query A string to be decoded.
+ * @returns A decoded query param object.
+ */
+export function decodeQueryString(query: string): { [key: string]: string } {
+  return query
+    .replace(/^#/, "")
+    .split("&")
+    .reduce(
+      (acc, entry) => {
+        const { key, value } = decodeParam(entry);
+        acc[key] = value;
+        return acc;
+      },
+      {} as any
+    );
+}

package/packages/arcgis-rest-request/src/utils/encode-form-data.ts

@@ -0,0 +1,38 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { processParams, requiresFormData } from "./process-params";
+import { encodeQueryString } from "./encode-query-string";
+/**
+ * Encodes parameters in a [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) object in browsers or in a [FormData](https://github.com/form-data/form-data) in Node.js
+ *
+ * @param params An object to be encoded.
+ * @returns The complete [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) object.
+ */
+export function encodeFormData(
+  params: any,
+  forceFormData?: boolean
+): FormData | string {
+  // see https://github.com/Esri/arcgis-rest-js/issues/499 for more info.
+  const useFormData = requiresFormData(params) || forceFormData;
+  const newParams = processParams(params);
+  if (useFormData) {
+    const formData = new FormData();
+    Object.keys(newParams).forEach((key: any) => {
+      if (typeof Blob !== "undefined" && newParams[key] instanceof Blob) {
+        /* To name the Blob:
+         1. look to an alternate request parameter called 'fileName'
+         2. see if 'name' has been tacked onto the Blob manually
+         3. if all else fails, use the request parameter
+        */
+        const filename = newParams["fileName"] || newParams[key].name || key;
+        formData.append(key, newParams[key], filename);
+      } else {
+        formData.append(key, newParams[key]);
+      }
+    });
+    return formData;
+  } else {
+    return encodeQueryString(params);
+  }
+}

package/packages/arcgis-rest-request/src/utils/encode-query-string.ts

@@ -0,0 +1,35 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { processParams } from "./process-params";
+
+/**
+ * Encodes keys and parameters for use in a URL's query string.
+ *
+ * @param key Parameter's key
+ * @param value Parameter's value
+ * @returns Query string with key and value pairs separated by "&"
+ */
+export function encodeParam(key: string, value: any): string {
+  // For array of arrays, repeat key=value for each element of containing array
+  if (Array.isArray(value) && value[0] && Array.isArray(value[0])) {
+    return value.map((arrayElem: string) => encodeParam(key, arrayElem)).join("&");
+  }
+
+  return encodeURIComponent(key) + "=" + encodeURIComponent(value);
+}
+
+/**
+ * Encodes the passed object as a query string.
+ *
+ * @param params An object to be encoded.
+ * @returns An encoded query string.
+ */
+export function encodeQueryString(params: any): string {
+  const newParams = processParams(params);
+  return Object.keys(newParams)
+    .map((key: any) => {
+      return encodeParam(key, newParams[key]);
+    })
+    .join("&");
+}

package/packages/arcgis-rest-request/src/utils/process-params.ts

@@ -0,0 +1,109 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+/**
+ * Checks parameters to see if we should use FormData to send the request
+ * @param params The object whose keys will be encoded.
+ * @return A boolean indicating if FormData will be required.
+ */
+export function requiresFormData(params: any) {
+  return Object.keys(params).some(key => {
+    let value = params[key];
+
+    if (!value) {
+      return false;
+    }
+
+    if (value && value.toParam) {
+      value = value.toParam();
+    }
+
+    const type = value.constructor.name;
+
+    switch (type) {
+      case "Array":
+        return false;
+      case "Object":
+        return false;
+      case "Date":
+        return false;
+      case "Function":
+        return false;
+      case "Boolean":
+        return false;
+      case "String":
+        return false;
+      case "Number":
+        return false;
+      default:
+        return true;
+    }
+  });
+}
+
+/**
+ * Converts parameters to the proper representation to send to the ArcGIS REST API.
+ * @param params The object whose keys will be encoded.
+ * @return A new object with properly encoded values.
+ */
+export function processParams(params: any): any {
+  const newParams: any = {};
+
+  Object.keys(params).forEach(key => {
+    let param = params[key];
+
+    if (param && param.toParam) {
+      param = param.toParam();
+    }
+
+    if (
+      !param &&
+      param !== 0 &&
+      typeof param !== "boolean" &&
+      typeof param !== "string"
+    ) {
+      return;
+    }
+
+    const type = param.constructor.name;
+
+    let value: any;
+
+    // properly encodes objects, arrays and dates for arcgis.com and other services.
+    // ported from https://github.com/Esri/esri-leaflet/blob/master/src/Request.js#L22-L30
+    // also see https://github.com/Esri/arcgis-rest-js/issues/18:
+    // null, undefined, function are excluded. If you want to send an empty key you need to send an empty string "".
+    switch (type) {
+      case "Array":
+        // Based on the first element of the array, classify array as an array of arrays, an array of objects
+        // to be stringified, or an array of non-objects to be comma-separated
+        // eslint-disable-next-line no-case-declarations
+        const firstElementType = param[0]?.constructor?.name;
+        value =
+          firstElementType === "Array" ? param : // pass thru array of arrays
+          firstElementType === "Object" ? JSON.stringify(param) : // stringify array of objects
+          param.join(","); // join other types of array elements
+        break;
+      case "Object":
+        value = JSON.stringify(param);
+        break;
+      case "Date":
+        value = param.valueOf();
+        break;
+      case "Function":
+        value = null;
+        break;
+      case "Boolean":
+        value = param + "";
+        break;
+      default:
+        value = param;
+        break;
+    }
+    if (value || value === 0 || typeof value === "string" || Array.isArray(value)) {
+      newParams[key] = value;
+    }
+  });
+
+  return newParams;
+}

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

@@ -0,0 +1,10 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IRequestOptions } from "./IRequestOptions";
+import { IAuthenticationManager } from "./IAuthenticationManager";
+
+export type IRetryAuthError = (
+  url: string,
+  options: IRequestOptions
+) => Promise<IAuthenticationManager>;

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

@@ -0,0 +1,11 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+/**
+ * Method used internally to surface messages to developers.
+ */
+export function warn(message: string) {
+  if (console && console.warn) {
+    console.warn.apply(console, [message]);
+  }
+}

package/packages/arcgis-rest-request/src/utils/with-options.ts

@@ -0,0 +1,48 @@
+import { IRequestOptions } from "../utils/IRequestOptions";
+
+/**
+ * Allows you to wrap individual methods with a default set of request options. This is useful to avoid setting the same option more then once and allows for interacting and setting defaults in a functional manner.
+ *
+ * ```js
+ * import { withOptions } from "@esri/arcgis-rest-request";
+ * import { queryFeatures } from '@esri/arcgis-rest-feature-layer';
+ *
+ * const queryTrails = withOptions({
+ *   url: "https://services3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Trailheads/FeatureServer/0/"}, queryFeatures);
+ *
+ * queryTrails({
+ *   where: "ELEV_FT > 1000"
+ * }).then(result);
+ *
+ * const queryTrailsAsUser = withOptions({
+ *   authentication: userSession
+ * }, queryTrails);
+ *
+ * queryTrailsAsUser({
+ *   where: "TRL_NAME LIKE '%backbone%'"
+ * }).then(result);
+ * ```
+ *
+ * @param defaultOptions The options to pass into to the `func`.
+ * @param func Any function that accepts anything extending `IRequestOptions` as its last parameter.
+ * @returns A copy of `func` with the `defaultOptions` passed in as defaults.
+ */
+export function withOptions<
+  K extends IRequestOptions,
+  T extends (...args: any[]) => any
+>(
+  defaultOptions: IRequestOptions,
+  func: T
+): (...funcArgs: Parameters<T>) => ReturnType<T> {
+  return (...args: Parameters<T>): ReturnType<T> => {
+    const options: K =
+      typeof args[args.length - 1] === "object"
+        ? {
+            ...defaultOptions,
+            ...args.pop()
+          }
+        : defaultOptions;
+
+    return func(...[...args, options]);
+  };
+}

package/packages/arcgis-rest-request/test/mocks/errors.ts

@@ -0,0 +1,76 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export const ArcGISOnlineError: any = {
+  error: {
+    code: 400,
+    message: "'type' and 'title' property required.",
+    details: []
+  }
+};
+
+export const ArcGISOnlineAuthError: any = {
+  error: {
+    code: 498,
+    message: "Invalid token.",
+    details: []
+  }
+};
+
+export const ArcGISOnlineErrorNoMessageCode: any = {
+  error: {
+    code: 403,
+    message:
+      "You do not have permissions to access this resource or perform this operation.",
+    details: []
+  }
+};
+
+export const ArcGISOnlineErrorNoCode: any = {
+  error: {
+    message:
+      "You do not have permissions to access this resource or perform this operation.",
+    details: []
+  }
+};
+
+export const ArcGISServerTokenRequired: any = {
+  error: {
+    code: 499,
+    message: "Token Required",
+    messageCode: "GWM_0003",
+    details: ["Token Required"]
+  }
+};
+
+export const BillingError: any = {
+  code: 500,
+  message: "Error getting subscription info",
+  status: "failure",
+  details: null as any
+};
+
+export const BillingErrorWithCode200: any = {
+  code: 200,
+  message: null,
+  status: "failure"
+};
+
+export const TaskErrorWithJSON: any = {
+  status: "failed",
+  statusMessage:
+    '{"code":400,"message":"Index was outside the bounds of the array."}'
+};
+
+export const TaskError: any = {
+  status: "failed",
+  statusMessage: "failed"
+};
+
+export const GenerateTokenError: any = {
+  error: {
+    code: 400,
+    message: "Unable to generate token.",
+    details: ["Invalid username or password."]
+  }
+};

package/packages/arcgis-rest-request/test/mocks/geojson-feature-collection.ts

@@ -0,0 +1,13 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export const GeoJSONFeatureCollection: any = {
+  type: "FeatureCollection",
+  crs: {
+    type: "name",
+    properties: {
+      name: "EPSG:4326"
+    }
+  },
+  features: []
+};

package/packages/arcgis-rest-request/test/mocks/param-builder.ts

@@ -0,0 +1,7 @@
+import { IParamBuilder } from "../../src/index";
+
+export class MockParamBuilder implements IParamBuilder {
+  public toParam() {
+    return "1=1";
+  }
+}

package/packages/arcgis-rest-request/test/mocks/sharing-rest-info.ts

@@ -0,0 +1,41 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export const SharingRestInfo = {
+  owningSystemUrl: "http://www.arcgis.com",
+  authInfo: {
+    tokenServicesUrl: "https://www.arcgis.com/sharing/rest/generateToken",
+    isTokenBasedSecurity: true
+  }
+};
+
+export const SharingRestInfoHTML = `<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+
+
+
+
+
+
+<html>
+<head>
+<title>ArcGIS Portal Directory</title>
+<link href="/sharing/rest/files/gw.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<br/>
+<div class="gwDiv">
+<table class="navTable" width="100%"><tr><td class="breadcrumbs">ArcGIS Portal Directory</td></tr></table>
+<tr valign="top">
+<br/><br/>
+<b>
+<a href="http://resources.arcgis.com/en/help/arcgis-rest-api/" >API Reference</a>
+</b>
+
+</tr>
+</table>
+
+</div>
+
+</body>
+
+</html>`;

package/packages/arcgis-rest-request/test/mocks/webmap.ts

@@ -0,0 +1,41 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export const WebMapAsText =
+  '{"operationalLayers":[{"id":"Alternative_Fueling_Stations_3694","layerType":"ArcGISFeatureLayer","url":"http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Alternative_Fueling_Stations/FeatureServer/0","visibility":true,"opacity":1,"title":"Alternative Fueling Stations","itemId":"44612e6217d34f40b1ce2a48f367e90a","layerDefinition":{"minScale":2896791,"maxScale":0}}],"baseMap":{"baseMapLayers":[{"id":"VectorTile_4047","type":"VectorTileLayer","layerType":"VectorTileLayer","title":"Dark Gray Canvas","styleUrl":"http://www.arcgis.com/sharing/rest/content/items/5ad3948260a147a993ef4865e3fad476/resources/styles/root.json","itemId":"5ad3948260a147a993ef4865e3fad476","visibility":true,"opacity":1}],"title":"Basemap"},"spatialReference":{"wkid":102100,"latestWkid":3857},"authoringApp":"WebMapViewer","authoringAppVersion":"5.1","version":"2.8"}';
+
+export const WebMapAsJSON = {
+  operationalLayers: [
+    {
+      id: "Alternative_Fueling_Stations_3694",
+      layerType: "ArcGISFeatureLayer",
+      url:
+        "http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Alternative_Fueling_Stations/FeatureServer/0",
+      visibility: true,
+      opacity: 1,
+      title: "Alternative Fueling Stations",
+      itemId: "44612e6217d34f40b1ce2a48f367e90a",
+      layerDefinition: { minScale: 2896791, maxScale: 0 }
+    }
+  ],
+  baseMap: {
+    baseMapLayers: [
+      {
+        id: "VectorTile_4047",
+        type: "VectorTileLayer",
+        layerType: "VectorTileLayer",
+        title: "Dark Gray Canvas",
+        styleUrl:
+          "http://www.arcgis.com/sharing/rest/content/items/5ad3948260a147a993ef4865e3fad476/resources/styles/root.json",
+        itemId: "5ad3948260a147a993ef4865e3fad476",
+        visibility: true,
+        opacity: 1
+      }
+    ],
+    title: "Basemap"
+  },
+  spatialReference: { wkid: 102100, latestWkid: 3857 },
+  authoringApp: "WebMapViewer",
+  authoringAppVersion: "5.1",
+  version: "2.8"
+};