etincidunt 1.0.0

package/packages/arcgis-rest-request/src/utils/check-for-errors.ts

@@ -0,0 +1,65 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { ArcGISRequestError } from "./ArcGISRequestError";
+import { ArcGISAuthError } from "./ArcGISAuthError";
+import { IRequestOptions, IParams } from "../request";
+/**
+ * Checks for errors in a JSON response from the ArcGIS REST API. If there are no errors, it will return the `data` passed in. If there is an error, it will throw an `ArcGISRequestError` or `ArcGISAuthError`.
+ *
+ * @param data The response JSON to check for errors.
+ * @param url The url of the original request
+ * @param params The parameters of the original request
+ * @param options The options of the original request
+ * @returns The data that was passed in the `data` parameter
+ */
+export function checkForErrors(
+  response: any,
+  url?: string,
+  params?: IParams,
+  options?: IRequestOptions
+): any {
+  // this is an error message from billing.arcgis.com backend
+  if (response.code >= 400) {
+    const { message, code } = response;
+    throw new ArcGISRequestError(message, code, response, url, options);
+  }
+
+  // error from ArcGIS Online or an ArcGIS Portal or server instance.
+  if (response.error) {
+    const { message, code, messageCode } = response.error;
+    const errorCode = messageCode || code || "UNKNOWN_ERROR_CODE";
+
+    if (code === 498 || code === 499 || messageCode === "GWM_0003") {
+      throw new ArcGISAuthError(message, errorCode, response, url, options);
+    }
+
+    throw new ArcGISRequestError(message, errorCode, response, url, options);
+  }
+
+  // error from a status check
+  if (response.status === "failed") {
+    let message: string;
+    let code: string = "UNKNOWN_ERROR_CODE";
+
+    try {
+      message = JSON.parse(response.statusMessage).message;
+      code = JSON.parse(response.statusMessage).code;
+    } catch (e) {
+      message = response.statusMessage;
+    }
+
+    throw new ArcGISRequestError(message, code, response, url, options);
+  }
+
+  return response;
+}
+
+/**
+ * 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/encode-form-data.ts

@@ -0,0 +1,29 @@
+/* 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): FormData | string {
+  const useFormData = requiresFormData(params);
+  const newParams = processParams(params);
+  if (useFormData) {
+    const formData = new FormData();
+    Object.keys(newParams).forEach((key: any) => {
+      if (key === "file" && newParams[key].name) {
+        // Pass on the file's name if provided to override defaults such as "blob"
+        formData.append(key, newParams[key], newParams[key].name);
+      } 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,23 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { processParams } from "./process-params";
+
+export function encodeParam(key: string, value: any) {
+  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/get-portal-url.ts

@@ -0,0 +1,25 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+import { IRequestOptions } from "../request";
+
+/**
+ * Helper that returns the portalUrl - either defaulting to www.arcgis.com or using
+ * the passed in auth manager's .portal property
+ *
+ * @param requestOptions - Request options that may have authentication manager
+ * @returns Portal url to be used in API requests
+ */
+export function getPortalUrl(requestOptions: IRequestOptions = {}): string {
+  // use portal in options if specified
+  if (requestOptions.portal) {
+    return requestOptions.portal;
+  }
+
+  // if the auth was passed, use that portal
+  if (requestOptions.authentication) {
+    return requestOptions.authentication.portal;
+  }
+
+  // default to arcgis.com
+  return "https://www.arcgis.com/sharing/rest";
+}

package/packages/arcgis-rest-request/src/utils/get-portal.ts

@@ -0,0 +1,45 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, IRequestOptions } from "../request";
+
+import { getPortalUrl } from "./get-portal-url";
+
+export interface IPortal {
+  id: string;
+  isPortal: boolean;
+  name: string;
+  [key: string]: any;
+}
+
+/**
+ * Get the portal
+ * @param requestOptions
+ */
+export function getSelf(requestOptions?: IRequestOptions): Promise<IPortal> {
+  // just delegate to getPortal w/o an id
+  return getPortal(null, requestOptions);
+}
+
+/**
+ * Get a portal by id. If no id is passed, it will call portals/self
+ * @param id
+ * @param requestOptions
+ */
+export function getPortal(
+  id?: string,
+  requestOptions?: IRequestOptions
+): Promise<IPortal> {
+  // construct the search url
+  const idOrSelf = id ? id : "self";
+  const url = `${getPortalUrl(requestOptions)}/portals/${idOrSelf}`;
+
+  // default to a GET request
+  const options: IRequestOptions = {
+    ...{ httpMethod: "GET" },
+    ...requestOptions
+  };
+
+  // send the request
+  return request(url, options);
+}

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

@@ -0,0 +1,99 @@
+/* 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 => {
+    const value = params[key];
+
+    if (!value) {
+      return false;
+    }
+
+    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 => {
+    const param = params[key];
+    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 objects to be stringified
+        // or an array of non-objects to be comma-separated
+        value =
+          param[0] &&
+          param[0].constructor &&
+          param[0].constructor.name === "Object"
+            ? JSON.stringify(param)
+            : param.join(",");
+        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") {
+      newParams[key] = value;
+    }
+  });
+
+  return newParams;
+}

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

@@ -0,0 +1,59 @@
+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 TaskErrorWithJSON: any = {
+  status: "failed",
+  statusMessage:
+    '{"code":400,"message":"Index was outside the bounds of the array."}'
+};
+
+export const TaskError: any = {
+  status: "failed",
+  statusMessage: "failed"
+};

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

@@ -0,0 +1,10 @@
+export const GeoJSONFeatureCollection: any = {
+  type: "FeatureCollection",
+  crs: {
+    type: "name",
+    properties: {
+      name: "EPSG:4326"
+    }
+  },
+  features: []
+};

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

@@ -0,0 +1,109 @@
+import { IPortal } from "../../src/utils/get-portal";
+
+export const PortalResponse: IPortal = {
+  access: "public",
+  allSSL: false,
+  allowedRedirectUris: [],
+  analysisLayersGroupQuery:
+    'title:"Living Atlas Analysis Layers" AND owner:esri',
+  authorizedCrossOriginDomains: [],
+  availableCredits: 9584.193,
+  basemapGalleryGroupQuery: "id:06d589ea1fdb47768ee3870f497333c0",
+  canListApps: false,
+  canListData: false,
+  canListPreProvisionedItems: false,
+  canProvisionDirectPurchase: false,
+  canSearchPublic: true,
+  canShareBingPublic: false,
+  canSharePublic: true,
+  canSignInArcGIS: true,
+  canSignInIDP: true,
+  colorSetsGroupQuery: 'title:"Esri Colors" AND owner:esri_en',
+  commentsEnabled: true,
+  created: 1392336986000,
+  creditAssignments: "enabled",
+  culture: "en",
+  customBaseUrl: "mapsdevext.arcgis.com",
+  databaseQuota: -1,
+  databaseUsage: -1,
+  defaultBasemap: {},
+  defaultExtent: {
+    type: "extent",
+    xmin: -8589300.590116454,
+    ymin: 4692777.971239516,
+    xmax: -8562027.314872108,
+    ymax: 4722244.554454538,
+    spatialReference: {
+      wkid: 102100
+    }
+  },
+  defaultUserCreditAssignment: 100,
+  defaultVectorBasemap: {
+    baseMapLayers: [],
+    title: "Topographic"
+  },
+  description: "We're the DC R&D Center",
+  eueiEnabled: false,
+  featuredGroups: [],
+  featuredGroupsId: "",
+  featuredItemsGroupQuery: "",
+  galleryTemplatesGroupQuery: 'title:"Gallery Templates" AND owner:esri_en',
+  hasCategorySchema: false,
+  helpBase: "http://docdev.arcgis.com/en/arcgis-online/",
+  helpMap: {},
+  helperServices: {},
+  homePageFeaturedContent: "",
+  homePageFeaturedContentCount: 12,
+  id: "LjjARY1mkhxulWPq",
+  isPortal: false,
+  layerTemplatesGroupQuery: 'title:"Esri Layer Templates" AND owner:esri_en',
+  livingAtlasGroupQuery: 'title:"Featured Maps And Apps" AND owner:esri',
+  maxTokenExpirationMinutes: -1,
+  metadataEditable: true,
+  metadataFormats: ["iso19139"],
+  modified: 1511894763000,
+  name: "Washington, DC",
+  notificationsEnabled: false,
+  portalHostname: "devext.arcgis.com",
+  portalMode: "multitenant",
+  portalName: "ArcGIS Online",
+  portalProperties: {},
+  portalThumbnail: null,
+  region: "WO",
+  rotatorPanels: [
+    {
+      id: "banner-2",
+      innerHTML:
+        "<img src='images/banner-2.jpg' style='-webkit-border-radius:0 0 10px 10px; -moz-border-radius:0 0 10px 10px; -o-border-radius:0 0 10px 10px; border-radius:0 0 10px 10px; margin-top:0; width:960px; height:180px;'/><div style='position:absolute; bottom:80px; left:80px; max-height:65px; width:660px; margin:0;'><img src='http://dc.mapsdevext.arcgis.com/sharing/rest/portals/self/resources/thumbnail.png?token=SECURITY_TOKEN' alt='Washington, DC'  class='esriFloatLeading esriTrailingMargin025' style='margin-bottom:0; max-height:100px;'/><span style='position:absolute; bottom:0; margin-bottom:0; line-height:normal; font-family:HelveticaNeue,Verdana; font-weight:600; font-size:32px; color:#369;'>Washington, DC</span></div>"
+    }
+  ],
+  showHomePageDescription: false,
+  staticImagesUrl: "http://static.arcgis.com/images",
+  storageQuota: 2199023255552,
+  storageUsage: 17622609523,
+  stylesGroupQuery: 'title:"Esri Styles" AND owner:esri_en',
+  supportsHostedServices: true,
+  symbolSetsGroupQuery: 'title:"Esri Symbols" AND owner:esri_en',
+  templatesGroupQuery: "id:f233da8d297e4ff9ae992c21f8f4010f",
+  thumbnail: "thumbnail.png",
+  units: "english",
+  updateUserProfileDisabled: false,
+  urlKey: "dc",
+  useStandardizedQuery: true,
+  useVectorBasemaps: false,
+  vectorBasemapGalleryGroupQuery:
+    'title:"ArcGIS Online Vector Basemaps" AND owner:esri_en',
+  subscriptionInfo: {},
+  isHubEnabled: false,
+  ipCntryCode: "US",
+  httpPort: 80,
+  httpsPort: 443,
+  supportsOAuth: true,
+  currentVersion: "5.4",
+  allowedOrigins: [],
+  mfaAdmins: [],
+  contacts: ["dcadmin"],
+  mfaEnabled: false,
+  user: {},
+  appInfo: {}
+};

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

@@ -0,0 +1,38 @@
+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,38 @@
+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"
+};