@esri/arcgis-rest-routing 4.0.0-beta.3 → 4.0.0

package/dist/cjs/closestFacility.js

@@ -15,9 +15,11 @@ function getTravelDirection(key) {
     }
 }
 /**
+ * Used to find a route to the nearest of several possible destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm) for more information.
+ *
  * ```js
  * import { closestFacility } from '@esri/arcgis-rest-routing';
- * //
+ *
  * closestFacility({
  *   incidents: [
  *     [-90.404302, 38.600621],
@@ -32,7 +34,6 @@ function getTravelDirection(key) {
  * })
  *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}
  * ```
- * Used to find a route to the nearest of several possible destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm) for more information.
  *
  * @param requestOptions Options to pass through to the routing service.
  * @returns A Promise that will resolve with routes and directions for the request.

package/dist/cjs/closestFacility.js.map

@@ -1 +1 @@
-{"version":3,"file":"closestFacility.js","sourceRoot":"","sources":["../../src/closestFacility.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,mEAQmC;AAEnC,6CAKsB;AAEtB,gDAAsD;AAsEtD,SAAS,kBAAkB,CACzB,GAAsD;IAEtD,IAAI,GAAG,KAAK,uBAAuB,EAAE;QACnC,OAAO,mCAAmC,CAAC;KAC5C;SAAM;QACL,OAAO,iCAAiC,CAAC;KAC1C;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,eAAe,CAC7B,cAAuC;IAEvC,MAAM,QAAQ,GACZ,cAAc,CAAC,QAAQ,IAAI,+CAAkC,CAAC;IAEhE,cAAc,CAAC,MAAM,mBACnB,gBAAgB,EAAE,IAAI,EACtB,gBAAgB,EAAE,IAAI,EACtB,eAAe,EAAE,IAAI,EACrB,cAAc,EAAE,IAAI,EACpB,sBAAsB,EAAE,IAAI,EAC5B,qBAAqB,EAAE,IAAI,EAC3B,gBAAgB,EAAE,IAAI,IACnB,cAAc,CAAC,MAAM,CACzB,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,wCAAkB,EAA0B,cAAc,EAAE;QAC1E,gBAAgB;QAChB,qBAAqB;QACrB,UAAU;QACV,kBAAkB;QAClB,iBAAiB;QACjB,kBAAkB;QAClB,sBAAsB;QACtB,uBAAuB;QACvB,aAAa;QACb,kBAAkB;QAClB,iBAAiB;QACjB,gBAAgB;QAChB,wBAAwB;QACxB,uBAAuB;QACvB,kBAAkB;KACnB,CAAC,CAAC;IAEH,sBAAsB;IACtB,IAAI,cAAc,CAAC,eAAe,EAAE;QAClC,OAAO,CAAC,MAAM,CAAC,eAAe,GAAG,kBAAkB,CACjD,cAAc,CAAC,eAAe,CAC/B,CAAC;KACH;IAED,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,QAAQ,KAAK,+CAAkC,EAC/C;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,+EAA+E,CAChF,CAAC;KACH;IAED,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,SAAS,CAAC,EAAE;QAC1C,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC;KACrD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,IAAA,mCAAsB,EAC/C,cAAc,CAAC,SAAS,CACzB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QAC3C,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC;KACvD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,IAAA,mCAAsB,EAChD,cAAc,CAAC,UAAU,CAC1B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,gEAAgE;IAChE,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SACnD;aAAM;YACL,2DAA2D;YAC3D,0CAA0C;YAC1C,uFAAuF;YACvF,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAA,mCAAsB,EAC9C,cAAc,CAAC,QAAQ,CACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACb;KACF;IAED,OAAO,IAAA,6BAAO,EAAC,GAAG,IAAA,8BAAQ,EAAC,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC,IAAI,CACxE,aAAa,CACd,CAAC;AACJ,CAAC;AArFD,0CAqFC;AAED,SAAS,aAAa,CAAC,GAAQ;IAC7B,qCAAqC;IACrC,IAAI,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC7C,GAAG,CAAC,MAAM,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KAClD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kBAAe;IACb,eAAe;CAChB,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  appendCustomParams,\n  ILocation,\n  IPoint,\n  IFeature,\n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_CLOSEST_FACILITY_URL,\n  IEndpointOptions,\n  normalizeLocationsList,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\nexport interface IClosestFacilityOptions extends IEndpointOptions {\n  /**\n   * Specify one or more locations from which the service searches for the nearby locations. These locations are referred to as incidents.\n   */\n  incidents: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n\n  /**\n   * Specify one or more locations that are searched for when finding the closest location.\n   */\n  facilities: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify if the service should return routes.\n   */\n  returnCFRoutes: boolean;\n  travelDirection?: \"incidentsToFacilities\" | \"facilitiesToIncidents\";\n  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  returnDirections?: boolean;\n  directionsOutputType?:\n    | \"esriDOTComplete\"\n    | \"esriDOTCompleteNoEvents\"\n    | \"esriDOTInstructionsOnly\"\n    | \"esriDOTStandard\"\n    | \"esriDOTSummaryOnly\"\n    | \"esriDOTFeatureSets\";\n  directionsLengthUnits?:\n    | \"esriNAUCentimeters\"\n    | \"esriNAUDecimalDegrees\"\n    | \"esriNAUDecimeters\"\n    | \"esriNAUFeet\"\n    | \"esriNAUInches\"\n    | \"esriNAUKilometers\"\n    | \"esriNAUMeters\"\n    | \"esriNAUMiles\"\n    | \"esriNAUMillimeters\"\n    | \"esriNAUNauticalMiles\"\n    | \"esriNAUPoints\"\n    | \"esriNAUYards\";\n  outputLines?: boolean;\n  returnFacilities?: boolean;\n  returnIncidents?: boolean;\n  returnBarriers?: boolean;\n  returnPolylineBarriers?: boolean;\n  returnPolygonBarriers?: boolean;\n  preserveObjectID?: boolean;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: any;\n}\n\nexport interface IClosestFacilityResponse {\n  messages: string[];\n  routes?: IFeatureSetWithGeoJson;\n  directions?: Array<{\n    routeId: number;\n    routeName: string;\n    summary: object;\n    features: IFeature[];\n  }>;\n  incidents?: IFeatureSet;\n  facilities?: IFeatureSet;\n  barriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n}\n\nfunction getTravelDirection(\n  key: \"incidentsToFacilities\" | \"facilitiesToIncidents\"\n): \"esriNATravelDirectionFromFacility\" | \"esriNATravelDirectionToFacility\" {\n  if (key === \"incidentsToFacilities\") {\n    return \"esriNATravelDirectionFromFacility\";\n  } else {\n    return \"esriNATravelDirectionToFacility\";\n  }\n}\n\n/**\n * ```js\n * import { closestFacility } from '@esri/arcgis-rest-routing';\n * //\n * closestFacility({\n *   incidents: [\n *     [-90.404302, 38.600621],\n *     [-90.364293, 38.620427],\n *    ],\n *   facilities: [\n *     [-90.444716, 38.635501],\n *     [-90.311919, 38.633523],\n *     [-90.451147, 38.581107]\n *    ],\n *    authentication\n * })\n *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}\n * ```\n * Used to find a route to the nearest of several possible destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm) for more information.\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with routes and directions for the request.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm\n * @inline IClosestFacilityOptions\n */\nexport function closestFacility(\n  requestOptions: IClosestFacilityOptions\n): Promise<IClosestFacilityResponse> {\n  const endpoint =\n    requestOptions.endpoint || ARCGIS_ONLINE_CLOSEST_FACILITY_URL;\n\n  requestOptions.params = {\n    returnFacilities: true,\n    returnDirections: true,\n    returnIncidents: true,\n    returnBarriers: true,\n    returnPolylineBarriers: true,\n    returnPolygonBarriers: true,\n    preserveObjectID: true,\n    ...requestOptions.params\n  };\n\n  const options = appendCustomParams<IClosestFacilityOptions>(requestOptions, [\n    \"returnCFRoutes\",\n    // \"travelDirection\",\n    \"barriers\",\n    \"polylineBarriers\",\n    \"polygonBarriers\",\n    \"returnDirections\",\n    \"directionsOutputType\",\n    \"directionsLengthUnits\",\n    \"outputLines\",\n    \"returnFacilities\",\n    \"returnIncidents\",\n    \"returnBarriers\",\n    \"returnPolylineBarriers\",\n    \"returnPolygonBarriers\",\n    \"preserveObjectID\"\n  ]);\n\n  // Set travelDirection\n  if (requestOptions.travelDirection) {\n    options.params.travelDirection = getTravelDirection(\n      requestOptions.travelDirection\n    );\n  }\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    endpoint === ARCGIS_ONLINE_CLOSEST_FACILITY_URL\n  ) {\n    return Promise.reject(\n      \"Finding the closest facility using the ArcGIS service requires authentication\"\n    );\n  }\n\n  if (isFeatureSet(requestOptions.incidents)) {\n    options.params.incidents = requestOptions.incidents;\n  } else {\n    options.params.incidents = normalizeLocationsList(\n      requestOptions.incidents\n    ).join(\";\");\n  }\n\n  if (isFeatureSet(requestOptions.facilities)) {\n    options.params.facilities = requestOptions.facilities;\n  } else {\n    options.params.facilities = normalizeLocationsList(\n      requestOptions.facilities\n    ).join(\";\");\n  }\n\n  // optional input param that may need point geometry normalizing\n  if (requestOptions.barriers) {\n    if (isFeatureSet(requestOptions.barriers)) {\n      options.params.barriers = requestOptions.barriers;\n    } else {\n      // optional point geometry barriers must be normalized, too\n      // but not if provided as IFeatureSet type\n      // note that optional polylineBarriers and polygonBarriers do not need to be normalized\n      options.params.barriers = normalizeLocationsList(\n        requestOptions.barriers\n      ).join(\";\");\n    }\n  }\n\n  return request(`${cleanUrl(endpoint)}/solveClosestFacility`, options).then(\n    cleanResponse\n  );\n}\n\nfunction cleanResponse(res: any): IClosestFacilityResponse {\n  // add \"geoJson\" property to \"routes\"\n  if (res.routes.spatialReference.wkid === 4326) {\n    res.routes.geoJson = arcgisToGeoJSON(res.routes);\n  }\n  return res;\n}\n\nexport default {\n  closestFacility\n};\n"]}
+{"version":3,"file":"closestFacility.js","sourceRoot":"","sources":["../../src/closestFacility.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,mEAQmC;AAEnC,6CAKsB;AAEtB,gDAAsD;AAsEtD,SAAS,kBAAkB,CACzB,GAAsD;IAEtD,IAAI,GAAG,KAAK,uBAAuB,EAAE;QACnC,OAAO,mCAAmC,CAAC;KAC5C;SAAM;QACL,OAAO,iCAAiC,CAAC;KAC1C;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,SAAgB,eAAe,CAC7B,cAAuC;IAEvC,MAAM,QAAQ,GACZ,cAAc,CAAC,QAAQ,IAAI,+CAAkC,CAAC;IAEhE,cAAc,CAAC,MAAM,mBACnB,gBAAgB,EAAE,IAAI,EACtB,gBAAgB,EAAE,IAAI,EACtB,eAAe,EAAE,IAAI,EACrB,cAAc,EAAE,IAAI,EACpB,sBAAsB,EAAE,IAAI,EAC5B,qBAAqB,EAAE,IAAI,EAC3B,gBAAgB,EAAE,IAAI,IACnB,cAAc,CAAC,MAAM,CACzB,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,wCAAkB,EAA0B,cAAc,EAAE;QAC1E,gBAAgB;QAChB,qBAAqB;QACrB,UAAU;QACV,kBAAkB;QAClB,iBAAiB;QACjB,kBAAkB;QAClB,sBAAsB;QACtB,uBAAuB;QACvB,aAAa;QACb,kBAAkB;QAClB,iBAAiB;QACjB,gBAAgB;QAChB,wBAAwB;QACxB,uBAAuB;QACvB,kBAAkB;KACnB,CAAC,CAAC;IAEH,sBAAsB;IACtB,IAAI,cAAc,CAAC,eAAe,EAAE;QAClC,OAAO,CAAC,MAAM,CAAC,eAAe,GAAG,kBAAkB,CACjD,cAAc,CAAC,eAAe,CAC/B,CAAC;KACH;IAED,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,QAAQ,KAAK,+CAAkC,EAC/C;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,+EAA+E,CAChF,CAAC;KACH;IAED,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,SAAS,CAAC,EAAE;QAC1C,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC;KACrD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,IAAA,mCAAsB,EAC/C,cAAc,CAAC,SAAS,CACzB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QAC3C,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC;KACvD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,IAAA,mCAAsB,EAChD,cAAc,CAAC,UAAU,CAC1B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,gEAAgE;IAChE,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SACnD;aAAM;YACL,2DAA2D;YAC3D,0CAA0C;YAC1C,uFAAuF;YACvF,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAA,mCAAsB,EAC9C,cAAc,CAAC,QAAQ,CACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACb;KACF;IAED,OAAO,IAAA,6BAAO,EAAC,GAAG,IAAA,8BAAQ,EAAC,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC,IAAI,CACxE,aAAa,CACd,CAAC;AACJ,CAAC;AArFD,0CAqFC;AAED,SAAS,aAAa,CAAC,GAAQ;IAC7B,qCAAqC;IACrC,IAAI,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC7C,GAAG,CAAC,MAAM,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KAClD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kBAAe;IACb,eAAe;CAChB,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  appendCustomParams,\n  ILocation,\n  IPoint,\n  IFeature,\n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_CLOSEST_FACILITY_URL,\n  IEndpointOptions,\n  normalizeLocationsList,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\nexport interface IClosestFacilityOptions extends IEndpointOptions {\n  /**\n   * Specify one or more locations from which the service searches for the nearby locations. These locations are referred to as incidents.\n   */\n  incidents: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n\n  /**\n   * Specify one or more locations that are searched for when finding the closest location.\n   */\n  facilities: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify if the service should return routes.\n   */\n  returnCFRoutes: boolean;\n  travelDirection?: \"incidentsToFacilities\" | \"facilitiesToIncidents\";\n  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  returnDirections?: boolean;\n  directionsOutputType?:\n    | \"esriDOTComplete\"\n    | \"esriDOTCompleteNoEvents\"\n    | \"esriDOTInstructionsOnly\"\n    | \"esriDOTStandard\"\n    | \"esriDOTSummaryOnly\"\n    | \"esriDOTFeatureSets\";\n  directionsLengthUnits?:\n    | \"esriNAUCentimeters\"\n    | \"esriNAUDecimalDegrees\"\n    | \"esriNAUDecimeters\"\n    | \"esriNAUFeet\"\n    | \"esriNAUInches\"\n    | \"esriNAUKilometers\"\n    | \"esriNAUMeters\"\n    | \"esriNAUMiles\"\n    | \"esriNAUMillimeters\"\n    | \"esriNAUNauticalMiles\"\n    | \"esriNAUPoints\"\n    | \"esriNAUYards\";\n  outputLines?: boolean;\n  returnFacilities?: boolean;\n  returnIncidents?: boolean;\n  returnBarriers?: boolean;\n  returnPolylineBarriers?: boolean;\n  returnPolygonBarriers?: boolean;\n  preserveObjectID?: boolean;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: any;\n}\n\nexport interface IClosestFacilityResponse {\n  messages: string[];\n  routes?: IFeatureSetWithGeoJson;\n  directions?: Array<{\n    routeId: number;\n    routeName: string;\n    summary: object;\n    features: IFeature[];\n  }>;\n  incidents?: IFeatureSet;\n  facilities?: IFeatureSet;\n  barriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n}\n\nfunction getTravelDirection(\n  key: \"incidentsToFacilities\" | \"facilitiesToIncidents\"\n): \"esriNATravelDirectionFromFacility\" | \"esriNATravelDirectionToFacility\" {\n  if (key === \"incidentsToFacilities\") {\n    return \"esriNATravelDirectionFromFacility\";\n  } else {\n    return \"esriNATravelDirectionToFacility\";\n  }\n}\n\n/**\n * Used to find a route to the nearest of several possible destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm) for more information.\n *\n * ```js\n * import { closestFacility } from '@esri/arcgis-rest-routing';\n *\n * closestFacility({\n *   incidents: [\n *     [-90.404302, 38.600621],\n *     [-90.364293, 38.620427],\n *    ],\n *   facilities: [\n *     [-90.444716, 38.635501],\n *     [-90.311919, 38.633523],\n *     [-90.451147, 38.581107]\n *    ],\n *    authentication\n * })\n *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}\n * ```\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with routes and directions for the request.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm\n * @inline IClosestFacilityOptions\n */\nexport function closestFacility(\n  requestOptions: IClosestFacilityOptions\n): Promise<IClosestFacilityResponse> {\n  const endpoint =\n    requestOptions.endpoint || ARCGIS_ONLINE_CLOSEST_FACILITY_URL;\n\n  requestOptions.params = {\n    returnFacilities: true,\n    returnDirections: true,\n    returnIncidents: true,\n    returnBarriers: true,\n    returnPolylineBarriers: true,\n    returnPolygonBarriers: true,\n    preserveObjectID: true,\n    ...requestOptions.params\n  };\n\n  const options = appendCustomParams<IClosestFacilityOptions>(requestOptions, [\n    \"returnCFRoutes\",\n    // \"travelDirection\",\n    \"barriers\",\n    \"polylineBarriers\",\n    \"polygonBarriers\",\n    \"returnDirections\",\n    \"directionsOutputType\",\n    \"directionsLengthUnits\",\n    \"outputLines\",\n    \"returnFacilities\",\n    \"returnIncidents\",\n    \"returnBarriers\",\n    \"returnPolylineBarriers\",\n    \"returnPolygonBarriers\",\n    \"preserveObjectID\"\n  ]);\n\n  // Set travelDirection\n  if (requestOptions.travelDirection) {\n    options.params.travelDirection = getTravelDirection(\n      requestOptions.travelDirection\n    );\n  }\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    endpoint === ARCGIS_ONLINE_CLOSEST_FACILITY_URL\n  ) {\n    return Promise.reject(\n      \"Finding the closest facility using the ArcGIS service requires authentication\"\n    );\n  }\n\n  if (isFeatureSet(requestOptions.incidents)) {\n    options.params.incidents = requestOptions.incidents;\n  } else {\n    options.params.incidents = normalizeLocationsList(\n      requestOptions.incidents\n    ).join(\";\");\n  }\n\n  if (isFeatureSet(requestOptions.facilities)) {\n    options.params.facilities = requestOptions.facilities;\n  } else {\n    options.params.facilities = normalizeLocationsList(\n      requestOptions.facilities\n    ).join(\";\");\n  }\n\n  // optional input param that may need point geometry normalizing\n  if (requestOptions.barriers) {\n    if (isFeatureSet(requestOptions.barriers)) {\n      options.params.barriers = requestOptions.barriers;\n    } else {\n      // optional point geometry barriers must be normalized, too\n      // but not if provided as IFeatureSet type\n      // note that optional polylineBarriers and polygonBarriers do not need to be normalized\n      options.params.barriers = normalizeLocationsList(\n        requestOptions.barriers\n      ).join(\";\");\n    }\n  }\n\n  return request(`${cleanUrl(endpoint)}/solveClosestFacility`, options).then(\n    cleanResponse\n  );\n}\n\nfunction cleanResponse(res: any): IClosestFacilityResponse {\n  // add \"geoJson\" property to \"routes\"\n  if (res.routes.spatialReference.wkid === 4326) {\n    res.routes.geoJson = arcgisToGeoJSON(res.routes);\n  }\n  return res;\n}\n\nexport default {\n  closestFacility\n};\n"]}

package/dist/cjs/originDestinationMatrix.js

@@ -7,9 +7,11 @@ const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
 const helpers_js_1 = require("./helpers.js");
 const arcgis_1 = require("@terraformer/arcgis");
 /**
+ * Used to create an origin-destination (OD) cost matrix from multiple origins to multiple destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm) for more information.
+ *
  * ```js
  * import { originDestinationMatrix } from '@esri/arcgis-rest-routing';
- * //
+ *
  * originDestinationMatrix({
  *   origins: [
  *     [-90.404302, 38.600621],
@@ -24,7 +26,6 @@ const arcgis_1 = require("@terraformer/arcgis");
  * })
  *   .then(response) // => { ... }
  * ```
- * Used to create an origin-destination (OD) cost matrix from multiple origins to multiple destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm) for more information.
  *
  * @param requestOptions Options to pass through to the routing service.
  * @returns A Promise that will resolve with travel time and/or distance for each origin-destination pair. It returns either odLines or odCostMatrix for this information depending on the outputType you specify.

package/dist/cjs/originDestinationMatrix.js.map

@@ -1 +1 @@
-{"version":3,"file":"originDestinationMatrix.js","sourceRoot":"","sources":["../../src/originDestinationMatrix.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,mEAQmC;AAEnC,6CAKsB;AAEtB,gDAAsD;AAiDtD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,uBAAuB,CACrC,cAA+C;IAE/C,MAAM,QAAQ,GACZ,cAAc,CAAC,QAAQ,IAAI,wDAA2C,CAAC;IAEzE,cAAc,CAAC,MAAM,mBACnB,UAAU,EAAE,4BAA4B,EACxC,aAAa,EAAE,IAAI,EACnB,kBAAkB,EAAE,IAAI,EACxB,cAAc,EAAE,IAAI,EACpB,sBAAsB,EAAE,IAAI,EAC5B,qBAAqB,EAAE,IAAI,IACxB,cAAc,CAAC,MAAM,CACzB,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,wCAAkB,EAChC,cAAc,EACd;QACE,YAAY;QACZ,UAAU;QACV,kBAAkB;QAClB,iBAAiB;QACjB,eAAe;QACf,oBAAoB;QACpB,gBAAgB;QAChB,wBAAwB;QACxB,uBAAuB;KACxB,CACF,CAAC;IAEF,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,QAAQ,KAAK,wDAA2C,EACxD;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,iGAAiG,CAClG,CAAC;KACH;IAED,sGAAsG;IACtG,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,OAAO,CAAC,EAAE;QACxC,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;KACjD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,IAAA,mCAAsB,EAC7C,cAAc,CAAC,OAAO,CACvB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,YAAY,CAAC,EAAE;QAC7C,OAAO,CAAC,MAAM,CAAC,YAAY,GAAG,cAAc,CAAC,YAAY,CAAC;KAC3D;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,YAAY,GAAG,IAAA,mCAAsB,EAClD,cAAc,CAAC,YAAY,CAC5B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,gEAAgE;IAChE,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SACnD;aAAM;YACL,2DAA2D;YAC3D,0CAA0C;YAC1C,uFAAuF;YACvF,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAA,mCAAsB,EAC9C,cAAc,CAAC,QAAQ,CACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACb;KACF;IAED,OAAO,IAAA,6BAAO,EAAC,GAAG,IAAA,8BAAQ,EAAC,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,IAAI,CACrE,UAAU,GAAG;QACX,OAAO,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC,CACF,CAAC;AACJ,CAAC;AA7ED,0DA6EC;AAED,SAAS,aAAa,CACpB,GAAQ,EACR,OAAwB;IAExB,gFAAgF;IAEhF,gIAAgI;IAChI,IACE,OAAO,CAAC,MAAM,CAAC,UAAU,KAAK,6BAA6B;QAC3D,GAAG,CAAC,OAAO;QACX,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAC1C;QACA,GAAG,CAAC,OAAO,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KACpD;IAED,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC7D,GAAG,CAAC,OAAO,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KACpD;IAED,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QACvE,GAAG,CAAC,YAAY,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,YAAY,CAAC,CAAC;KAC9D;IAED,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC/D,GAAG,CAAC,QAAQ,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;KACtD;IAED,IACE,GAAG,CAAC,eAAe;QACnB,GAAG,CAAC,eAAe,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAClD;QACA,GAAG,CAAC,eAAe,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,eAAe,CAAC,CAAC;KACpE;IAED,IACE,GAAG,CAAC,gBAAgB;QACpB,GAAG,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EACnD;QACA,GAAG,CAAC,gBAAgB,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;KACtE;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kBAAe;IACb,uBAAuB;CACxB,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  appendCustomParams,\n  IRequestOptions,\n  ILocation, \n  IPoint, \n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL,\n  IEndpointOptions,\n  normalizeLocationsList,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\nexport interface IOriginDestinationMatrixOptions extends IEndpointOptions {\n  /**\n   *  Specify the starting points from which to travel to the destinations.\n   */\n  origins: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify the ending point locations to travel to from the origins.\n   */\n  destinations: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify the type of output returned by the service. Defaults to \"esriNAODOutputSparseMatrix\".\n   */\n  outputType?:\n    | \"esriNAODOutputSparseMatrix\"\n    | \"esriNAODOutputStraightLines\"\n    | \"esriNAODOutputNoLines\";\n  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  returnOrigins?: boolean;\n  returnDestinations?: boolean;\n  returnBarriers?: boolean;\n  returnPolylineBarriers?: boolean;\n  returnPolygonBarriers?: boolean;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: any;\n}\n\nexport interface IOriginDestinationMatrixResponse {\n  messages: [{ type: number; description: string }];\n  /**\n   *  Only present if outputType is \"esriNAODOutputSparseMatrix\". Full description is available at https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm#ESRI_SECTION2_114F8364507C4B56B780DFAD505270FB.\n   */\n  odCostMatrix?: any;\n  /**\n   *  Only present if outputType is \"esriNAODOutputStraightLines\" or \"esriNAODOutputNoLines\". Includes the geometry for the straight line connecting each origin-destination pair when the outputType is \"esriNAODOutputStraightLines\".\n   */\n  odLines?: IFeatureSetWithGeoJson;\n  origins?: IFeatureSetWithGeoJson;\n  destinations?: IFeatureSetWithGeoJson;\n  barriers?: IFeatureSetWithGeoJson;\n  polylineBarriers?: IFeatureSetWithGeoJson;\n  polygonBarriers?: IFeatureSetWithGeoJson;\n}\n\n/**\n * ```js\n * import { originDestinationMatrix } from '@esri/arcgis-rest-routing';\n * //\n * originDestinationMatrix({\n *   origins: [\n *     [-90.404302, 38.600621],\n *     [-90.364293, 38.620427],\n *   ],\n *   destinations: [\n *     [-90.444716, 38.635501],\n *     [-90.311919, 38.633523],\n *     [-90.451147, 38.581107]\n *   ],\n *   authentication\n * })\n *   .then(response) // => { ... }\n * ```\n * Used to create an origin-destination (OD) cost matrix from multiple origins to multiple destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm) for more information.\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with travel time and/or distance for each origin-destination pair. It returns either odLines or odCostMatrix for this information depending on the outputType you specify.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm\n */\nexport function originDestinationMatrix(\n  requestOptions: IOriginDestinationMatrixOptions\n): Promise<IOriginDestinationMatrixResponse> {\n  const endpoint =\n    requestOptions.endpoint || ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL;\n\n  requestOptions.params = {\n    outputType: \"esriNAODOutputSparseMatrix\",\n    returnOrigins: true,\n    returnDestinations: true,\n    returnBarriers: true,\n    returnPolylineBarriers: true,\n    returnPolygonBarriers: true,\n    ...requestOptions.params\n  };\n\n  const options = appendCustomParams<IOriginDestinationMatrixOptions>(\n    requestOptions,\n    [\n      \"outputType\",\n      \"barriers\",\n      \"polylineBarriers\",\n      \"polygonBarriers\",\n      \"returnOrigins\",\n      \"returnDestinations\",\n      \"returnBarriers\",\n      \"returnPolylineBarriers\",\n      \"returnPolygonBarriers\"\n    ]\n  );\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    endpoint === ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL\n  ) {\n    return Promise.reject(\n      \"Calculating the origin-destination cost matrix using the ArcGIS service requires authentication\"\n    );\n  }\n\n  // use a formatting helper for input params of this type: Array<IPoint | ILocation | [number, number]>\n  if (isFeatureSet(requestOptions.origins)) {\n    options.params.origins = requestOptions.origins;\n  } else {\n    options.params.origins = normalizeLocationsList(\n      requestOptions.origins\n    ).join(\";\");\n  }\n\n  if (isFeatureSet(requestOptions.destinations)) {\n    options.params.destinations = requestOptions.destinations;\n  } else {\n    options.params.destinations = normalizeLocationsList(\n      requestOptions.destinations\n    ).join(\";\");\n  }\n\n  // optional input param that may need point geometry normalizing\n  if (requestOptions.barriers) {\n    if (isFeatureSet(requestOptions.barriers)) {\n      options.params.barriers = requestOptions.barriers;\n    } else {\n      // optional point geometry barriers must be normalized, too\n      // but not if provided as IFeatureSet type\n      // note that optional polylineBarriers and polygonBarriers do not need to be normalized\n      options.params.barriers = normalizeLocationsList(\n        requestOptions.barriers\n      ).join(\";\");\n    }\n  }\n\n  return request(`${cleanUrl(endpoint)}/solveODCostMatrix`, options).then(\n    function (res) {\n      return cleanResponse(res, options);\n    }\n  );\n}\n\nfunction cleanResponse(\n  res: any,\n  options: IRequestOptions\n): IOriginDestinationMatrixResponse {\n  // add \"geoJson\" property to each response property that is an arcgis featureSet\n\n  // res.odLines only exists and only includes geometry in this condition (out of 3 possible options.params.outputType conditions)\n  if (\n    options.params.outputType === \"esriNAODOutputStraightLines\" &&\n    res.odLines &&\n    res.odLines.spatialReference.wkid === 4326\n  ) {\n    res.odLines.geoJson = arcgisToGeoJSON(res.odLines);\n  }\n\n  if (res.origins && res.origins.spatialReference.wkid === 4326) {\n    res.origins.geoJson = arcgisToGeoJSON(res.origins);\n  }\n\n  if (res.destinations && res.destinations.spatialReference.wkid === 4326) {\n    res.destinations.geoJson = arcgisToGeoJSON(res.destinations);\n  }\n\n  if (res.barriers && res.barriers.spatialReference.wkid === 4326) {\n    res.barriers.geoJson = arcgisToGeoJSON(res.barriers);\n  }\n\n  if (\n    res.polygonBarriers &&\n    res.polygonBarriers.spatialReference.wkid === 4326\n  ) {\n    res.polygonBarriers.geoJson = arcgisToGeoJSON(res.polygonBarriers);\n  }\n\n  if (\n    res.polylineBarriers &&\n    res.polylineBarriers.spatialReference.wkid === 4326\n  ) {\n    res.polylineBarriers.geoJson = arcgisToGeoJSON(res.polylineBarriers);\n  }\n\n  return res;\n}\n\nexport default {\n  originDestinationMatrix\n};\n"]}
+{"version":3,"file":"originDestinationMatrix.js","sourceRoot":"","sources":["../../src/originDestinationMatrix.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,mEAQmC;AAEnC,6CAKsB;AAEtB,gDAAsD;AAiDtD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,uBAAuB,CACrC,cAA+C;IAE/C,MAAM,QAAQ,GACZ,cAAc,CAAC,QAAQ,IAAI,wDAA2C,CAAC;IAEzE,cAAc,CAAC,MAAM,mBACnB,UAAU,EAAE,4BAA4B,EACxC,aAAa,EAAE,IAAI,EACnB,kBAAkB,EAAE,IAAI,EACxB,cAAc,EAAE,IAAI,EACpB,sBAAsB,EAAE,IAAI,EAC5B,qBAAqB,EAAE,IAAI,IACxB,cAAc,CAAC,MAAM,CACzB,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,wCAAkB,EAChC,cAAc,EACd;QACE,YAAY;QACZ,UAAU;QACV,kBAAkB;QAClB,iBAAiB;QACjB,eAAe;QACf,oBAAoB;QACpB,gBAAgB;QAChB,wBAAwB;QACxB,uBAAuB;KACxB,CACF,CAAC;IAEF,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,QAAQ,KAAK,wDAA2C,EACxD;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,iGAAiG,CAClG,CAAC;KACH;IAED,sGAAsG;IACtG,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,OAAO,CAAC,EAAE;QACxC,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;KACjD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,IAAA,mCAAsB,EAC7C,cAAc,CAAC,OAAO,CACvB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,YAAY,CAAC,EAAE;QAC7C,OAAO,CAAC,MAAM,CAAC,YAAY,GAAG,cAAc,CAAC,YAAY,CAAC;KAC3D;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,YAAY,GAAG,IAAA,mCAAsB,EAClD,cAAc,CAAC,YAAY,CAC5B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,gEAAgE;IAChE,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SACnD;aAAM;YACL,2DAA2D;YAC3D,0CAA0C;YAC1C,uFAAuF;YACvF,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAA,mCAAsB,EAC9C,cAAc,CAAC,QAAQ,CACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACb;KACF;IAED,OAAO,IAAA,6BAAO,EAAC,GAAG,IAAA,8BAAQ,EAAC,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,IAAI,CACrE,UAAU,GAAG;QACX,OAAO,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC,CACF,CAAC;AACJ,CAAC;AA7ED,0DA6EC;AAED,SAAS,aAAa,CACpB,GAAQ,EACR,OAAwB;IAExB,gFAAgF;IAEhF,gIAAgI;IAChI,IACE,OAAO,CAAC,MAAM,CAAC,UAAU,KAAK,6BAA6B;QAC3D,GAAG,CAAC,OAAO;QACX,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAC1C;QACA,GAAG,CAAC,OAAO,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KACpD;IAED,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC7D,GAAG,CAAC,OAAO,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KACpD;IAED,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QACvE,GAAG,CAAC,YAAY,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,YAAY,CAAC,CAAC;KAC9D;IAED,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC/D,GAAG,CAAC,QAAQ,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;KACtD;IAED,IACE,GAAG,CAAC,eAAe;QACnB,GAAG,CAAC,eAAe,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAClD;QACA,GAAG,CAAC,eAAe,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,eAAe,CAAC,CAAC;KACpE;IAED,IACE,GAAG,CAAC,gBAAgB;QACpB,GAAG,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EACnD;QACA,GAAG,CAAC,gBAAgB,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;KACtE;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kBAAe;IACb,uBAAuB;CACxB,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  appendCustomParams,\n  IRequestOptions,\n  ILocation,\n  IPoint,\n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL,\n  IEndpointOptions,\n  normalizeLocationsList,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\nexport interface IOriginDestinationMatrixOptions extends IEndpointOptions {\n  /**\n   *  Specify the starting points from which to travel to the destinations.\n   */\n  origins: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify the ending point locations to travel to from the origins.\n   */\n  destinations: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify the type of output returned by the service. Defaults to \"esriNAODOutputSparseMatrix\".\n   */\n  outputType?:\n    | \"esriNAODOutputSparseMatrix\"\n    | \"esriNAODOutputStraightLines\"\n    | \"esriNAODOutputNoLines\";\n  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  returnOrigins?: boolean;\n  returnDestinations?: boolean;\n  returnBarriers?: boolean;\n  returnPolylineBarriers?: boolean;\n  returnPolygonBarriers?: boolean;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: any;\n}\n\nexport interface IOriginDestinationMatrixResponse {\n  messages: [{ type: number; description: string }];\n  /**\n   *  Only present if outputType is \"esriNAODOutputSparseMatrix\". Full description is available at https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm#ESRI_SECTION2_114F8364507C4B56B780DFAD505270FB.\n   */\n  odCostMatrix?: any;\n  /**\n   *  Only present if outputType is \"esriNAODOutputStraightLines\" or \"esriNAODOutputNoLines\". Includes the geometry for the straight line connecting each origin-destination pair when the outputType is \"esriNAODOutputStraightLines\".\n   */\n  odLines?: IFeatureSetWithGeoJson;\n  origins?: IFeatureSetWithGeoJson;\n  destinations?: IFeatureSetWithGeoJson;\n  barriers?: IFeatureSetWithGeoJson;\n  polylineBarriers?: IFeatureSetWithGeoJson;\n  polygonBarriers?: IFeatureSetWithGeoJson;\n}\n\n/**\n * Used to create an origin-destination (OD) cost matrix from multiple origins to multiple destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm) for more information.\n *\n * ```js\n * import { originDestinationMatrix } from '@esri/arcgis-rest-routing';\n *\n * originDestinationMatrix({\n *   origins: [\n *     [-90.404302, 38.600621],\n *     [-90.364293, 38.620427],\n *   ],\n *   destinations: [\n *     [-90.444716, 38.635501],\n *     [-90.311919, 38.633523],\n *     [-90.451147, 38.581107]\n *   ],\n *   authentication\n * })\n *   .then(response) // => { ... }\n * ```\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with travel time and/or distance for each origin-destination pair. It returns either odLines or odCostMatrix for this information depending on the outputType you specify.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm\n */\nexport function originDestinationMatrix(\n  requestOptions: IOriginDestinationMatrixOptions\n): Promise<IOriginDestinationMatrixResponse> {\n  const endpoint =\n    requestOptions.endpoint || ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL;\n\n  requestOptions.params = {\n    outputType: \"esriNAODOutputSparseMatrix\",\n    returnOrigins: true,\n    returnDestinations: true,\n    returnBarriers: true,\n    returnPolylineBarriers: true,\n    returnPolygonBarriers: true,\n    ...requestOptions.params\n  };\n\n  const options = appendCustomParams<IOriginDestinationMatrixOptions>(\n    requestOptions,\n    [\n      \"outputType\",\n      \"barriers\",\n      \"polylineBarriers\",\n      \"polygonBarriers\",\n      \"returnOrigins\",\n      \"returnDestinations\",\n      \"returnBarriers\",\n      \"returnPolylineBarriers\",\n      \"returnPolygonBarriers\"\n    ]\n  );\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    endpoint === ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL\n  ) {\n    return Promise.reject(\n      \"Calculating the origin-destination cost matrix using the ArcGIS service requires authentication\"\n    );\n  }\n\n  // use a formatting helper for input params of this type: Array<IPoint | ILocation | [number, number]>\n  if (isFeatureSet(requestOptions.origins)) {\n    options.params.origins = requestOptions.origins;\n  } else {\n    options.params.origins = normalizeLocationsList(\n      requestOptions.origins\n    ).join(\";\");\n  }\n\n  if (isFeatureSet(requestOptions.destinations)) {\n    options.params.destinations = requestOptions.destinations;\n  } else {\n    options.params.destinations = normalizeLocationsList(\n      requestOptions.destinations\n    ).join(\";\");\n  }\n\n  // optional input param that may need point geometry normalizing\n  if (requestOptions.barriers) {\n    if (isFeatureSet(requestOptions.barriers)) {\n      options.params.barriers = requestOptions.barriers;\n    } else {\n      // optional point geometry barriers must be normalized, too\n      // but not if provided as IFeatureSet type\n      // note that optional polylineBarriers and polygonBarriers do not need to be normalized\n      options.params.barriers = normalizeLocationsList(\n        requestOptions.barriers\n      ).join(\";\");\n    }\n  }\n\n  return request(`${cleanUrl(endpoint)}/solveODCostMatrix`, options).then(\n    function (res) {\n      return cleanResponse(res, options);\n    }\n  );\n}\n\nfunction cleanResponse(\n  res: any,\n  options: IRequestOptions\n): IOriginDestinationMatrixResponse {\n  // add \"geoJson\" property to each response property that is an arcgis featureSet\n\n  // res.odLines only exists and only includes geometry in this condition (out of 3 possible options.params.outputType conditions)\n  if (\n    options.params.outputType === \"esriNAODOutputStraightLines\" &&\n    res.odLines &&\n    res.odLines.spatialReference.wkid === 4326\n  ) {\n    res.odLines.geoJson = arcgisToGeoJSON(res.odLines);\n  }\n\n  if (res.origins && res.origins.spatialReference.wkid === 4326) {\n    res.origins.geoJson = arcgisToGeoJSON(res.origins);\n  }\n\n  if (res.destinations && res.destinations.spatialReference.wkid === 4326) {\n    res.destinations.geoJson = arcgisToGeoJSON(res.destinations);\n  }\n\n  if (res.barriers && res.barriers.spatialReference.wkid === 4326) {\n    res.barriers.geoJson = arcgisToGeoJSON(res.barriers);\n  }\n\n  if (\n    res.polygonBarriers &&\n    res.polygonBarriers.spatialReference.wkid === 4326\n  ) {\n    res.polygonBarriers.geoJson = arcgisToGeoJSON(res.polygonBarriers);\n  }\n\n  if (\n    res.polylineBarriers &&\n    res.polylineBarriers.spatialReference.wkid === 4326\n  ) {\n    res.polylineBarriers.geoJson = arcgisToGeoJSON(res.polylineBarriers);\n  }\n\n  return res;\n}\n\nexport default {\n  originDestinationMatrix\n};\n"]}

package/dist/cjs/serviceArea.js

@@ -15,9 +15,11 @@ function getTravelDirection(key) {
     }
 }
 /**
+ * Used to find the area that can be reached from the input location within a given travel time or travel distance. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm) for more information.
+ *
  * ```js
  * import { serviceArea } from '@esri/arcgis-rest-routing';
- * //
+ *
  * serviceArea({
  *   facilities: [
  *     [-90.444716, 38.635501],
@@ -28,7 +30,6 @@ function getTravelDirection(key) {
  * })
  *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}
  * ```
- * Used to find the area that can be reached from the input location within a given travel time or travel distance. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm) for more information.
  *
  * @param requestOptions Options to pass through to the routing service.
  * @returns A Promise that will resolve with service area polygons for the request.

package/dist/cjs/serviceArea.js.map

@@ -1 +1 @@
-{"version":3,"file":"serviceArea.js","sourceRoot":"","sources":["../../src/serviceArea.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,mEAOmC;AAEnC,6CAKsB;AAEtB,gDAAsD;AAoCtD,SAAS,kBAAkB,CACzB,GAAsD;IAEtD,IAAI,GAAG,KAAK,uBAAuB,EAAE;QACnC,OAAO,mCAAmC,CAAC;KAC5C;SAAM;QACL,OAAO,iCAAiC,CAAC;KAC1C;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,WAAW,CACzB,cAAmC;IAEnC,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,IAAI,2CAA8B,CAAC;IAE3E,cAAc,CAAC,MAAM,mBACnB,gBAAgB,EAAE,IAAI,EACtB,cAAc,EAAE,IAAI,EACpB,sBAAsB,EAAE,IAAI,EAC5B,qBAAqB,EAAE,IAAI,EAC3B,gBAAgB,EAAE,IAAI,IACnB,cAAc,CAAC,MAAM,CACzB,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,wCAAkB,EAAsB,cAAc,EAAE;QACtE,UAAU;QACV,kBAAkB;QAClB,iBAAiB;QACjB,aAAa;QACb,kBAAkB;QAClB,gBAAgB;QAChB,wBAAwB;QACxB,uBAAuB;QACvB,kBAAkB;KACnB,CAAC,CAAC;IAEH,sBAAsB;IACtB,IAAI,cAAc,CAAC,eAAe,EAAE;QAClC,OAAO,CAAC,MAAM,CAAC,eAAe,GAAG,kBAAkB,CACjD,cAAc,CAAC,eAAe,CAC/B,CAAC;KACH;IAED,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,QAAQ,KAAK,2CAA8B,EAC3C;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,wEAAwE,CACzE,CAAC;KACH;IAED,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QAC3C,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC;KACvD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,IAAA,mCAAsB,EAChD,cAAc,CAAC,UAAU,CAC1B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,gEAAgE;IAChE,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SACnD;aAAM;YACL,2DAA2D;YAC3D,0CAA0C;YAC1C,uFAAuF;YACvF,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAA,mCAAsB,EAC9C,cAAc,CAAC,QAAQ,CACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACb;KACF;IAED,OAAO,IAAA,6BAAO,EAAC,GAAG,IAAA,8BAAQ,EAAC,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,IAAI,CACpE,aAAa,CACd,CAAC;AACJ,CAAC;AApED,kCAoEC;AAED,SAAS,aAAa,CAAC,GAAQ;IAC7B,yDAAyD;IACzD,OAAO,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC;IAEnC,yCAAyC;IACzC,IAAI,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QACjD,GAAG,CAAC,UAAU,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,UAAU,CAAC,CAAC;KAC1D;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kBAAe;IACb,WAAW;CACZ,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  appendCustomParams,\n  ILocation, \n  IPoint, \n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_SERVICE_AREA_URL,\n  IEndpointOptions,\n  normalizeLocationsList,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\nexport interface IServiceAreaOptions extends IEndpointOptions {\n  /**\n   *  Specify one or more locations around which service areas are generated.\n   */\n  facilities: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify if the service should return routes.\n   */\n  travelDirection?: \"incidentsToFacilities\" | \"facilitiesToIncidents\";\n  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  outputLines?: boolean;\n  returnFacilities?: boolean;\n  returnBarriers?: boolean;\n  returnPolylineBarriers?: boolean;\n  returnPolygonBarriers?: boolean;\n  preserveObjectID?: boolean;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: any;\n}\n\nexport interface IServiceAreaResponse {\n  messages: string[];\n  saPolygons?: IFeatureSetWithGeoJson;\n  incidents?: IFeatureSet;\n  facilities?: IFeatureSet;\n  barriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n}\n\nfunction getTravelDirection(\n  key: \"incidentsToFacilities\" | \"facilitiesToIncidents\"\n): \"esriNATravelDirectionFromFacility\" | \"esriNATravelDirectionToFacility\" {\n  if (key === \"incidentsToFacilities\") {\n    return \"esriNATravelDirectionFromFacility\";\n  } else {\n    return \"esriNATravelDirectionToFacility\";\n  }\n}\n\n/**\n * ```js\n * import { serviceArea } from '@esri/arcgis-rest-routing';\n * //\n * serviceArea({\n *   facilities: [\n *     [-90.444716, 38.635501],\n *     [-90.311919, 38.633523],\n *     [-90.451147, 38.581107]\n *    ],\n *    authentication\n * })\n *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}\n * ```\n * Used to find the area that can be reached from the input location within a given travel time or travel distance. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm) for more information.\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with service area polygons for the request.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm\n */\nexport function serviceArea(\n  requestOptions: IServiceAreaOptions\n): Promise<IServiceAreaResponse> {\n  const endpoint = requestOptions.endpoint || ARCGIS_ONLINE_SERVICE_AREA_URL;\n\n  requestOptions.params = {\n    returnFacilities: true,\n    returnBarriers: true,\n    returnPolylineBarriers: true,\n    returnPolygonBarriers: true,\n    preserveObjectID: true,\n    ...requestOptions.params\n  };\n\n  const options = appendCustomParams<IServiceAreaOptions>(requestOptions, [\n    \"barriers\",\n    \"polylineBarriers\",\n    \"polygonBarriers\",\n    \"outputLines\",\n    \"returnFacilities\",\n    \"returnBarriers\",\n    \"returnPolylineBarriers\",\n    \"returnPolygonBarriers\",\n    \"preserveObjectID\"\n  ]);\n\n  // Set travelDirection\n  if (requestOptions.travelDirection) {\n    options.params.travelDirection = getTravelDirection(\n      requestOptions.travelDirection\n    );\n  }\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    endpoint === ARCGIS_ONLINE_SERVICE_AREA_URL\n  ) {\n    return Promise.reject(\n      \"Finding service areas using the ArcGIS service requires authentication\"\n    );\n  }\n\n  if (isFeatureSet(requestOptions.facilities)) {\n    options.params.facilities = requestOptions.facilities;\n  } else {\n    options.params.facilities = normalizeLocationsList(\n      requestOptions.facilities\n    ).join(\";\");\n  }\n\n  // optional input param that may need point geometry normalizing\n  if (requestOptions.barriers) {\n    if (isFeatureSet(requestOptions.barriers)) {\n      options.params.barriers = requestOptions.barriers;\n    } else {\n      // optional point geometry barriers must be normalized, too\n      // but not if provided as IFeatureSet type\n      // note that optional polylineBarriers and polygonBarriers do not need to be normalized\n      options.params.barriers = normalizeLocationsList(\n        requestOptions.barriers\n      ).join(\";\");\n    }\n  }\n\n  return request(`${cleanUrl(endpoint)}/solveServiceArea`, options).then(\n    cleanResponse\n  );\n}\n\nfunction cleanResponse(res: any): IServiceAreaResponse {\n  // remove \"fieldAliases\" because it does not do anything.\n  delete res.saPolygons.fieldAliases;\n\n  // add \"geoJson\" property to \"saPolygons\"\n  if (res.saPolygons.spatialReference.wkid === 4326) {\n    res.saPolygons.geoJson = arcgisToGeoJSON(res.saPolygons);\n  }\n  return res;\n}\n\nexport default {\n  serviceArea\n};\n"]}
+{"version":3,"file":"serviceArea.js","sourceRoot":"","sources":["../../src/serviceArea.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,mEAOmC;AAEnC,6CAKsB;AAEtB,gDAAsD;AAoCtD,SAAS,kBAAkB,CACzB,GAAsD;IAEtD,IAAI,GAAG,KAAK,uBAAuB,EAAE;QACnC,OAAO,mCAAmC,CAAC;KAC5C;SAAM;QACL,OAAO,iCAAiC,CAAC;KAC1C;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,WAAW,CACzB,cAAmC;IAEnC,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,IAAI,2CAA8B,CAAC;IAE3E,cAAc,CAAC,MAAM,mBACnB,gBAAgB,EAAE,IAAI,EACtB,cAAc,EAAE,IAAI,EACpB,sBAAsB,EAAE,IAAI,EAC5B,qBAAqB,EAAE,IAAI,EAC3B,gBAAgB,EAAE,IAAI,IACnB,cAAc,CAAC,MAAM,CACzB,CAAC;IAEF,MAAM,OAAO,GAAG,IAAA,wCAAkB,EAAsB,cAAc,EAAE;QACtE,UAAU;QACV,kBAAkB;QAClB,iBAAiB;QACjB,aAAa;QACb,kBAAkB;QAClB,gBAAgB;QAChB,wBAAwB;QACxB,uBAAuB;QACvB,kBAAkB;KACnB,CAAC,CAAC;IAEH,sBAAsB;IACtB,IAAI,cAAc,CAAC,eAAe,EAAE;QAClC,OAAO,CAAC,MAAM,CAAC,eAAe,GAAG,kBAAkB,CACjD,cAAc,CAAC,eAAe,CAC/B,CAAC;KACH;IAED,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,QAAQ,KAAK,2CAA8B,EAC3C;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,wEAAwE,CACzE,CAAC;KACH;IAED,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QAC3C,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC;KACvD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,IAAA,mCAAsB,EAChD,cAAc,CAAC,UAAU,CAC1B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,gEAAgE;IAChE,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SACnD;aAAM;YACL,2DAA2D;YAC3D,0CAA0C;YAC1C,uFAAuF;YACvF,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAA,mCAAsB,EAC9C,cAAc,CAAC,QAAQ,CACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACb;KACF;IAED,OAAO,IAAA,6BAAO,EAAC,GAAG,IAAA,8BAAQ,EAAC,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,IAAI,CACpE,aAAa,CACd,CAAC;AACJ,CAAC;AApED,kCAoEC;AAED,SAAS,aAAa,CAAC,GAAQ;IAC7B,yDAAyD;IACzD,OAAO,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC;IAEnC,yCAAyC;IACzC,IAAI,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QACjD,GAAG,CAAC,UAAU,CAAC,OAAO,GAAG,IAAA,wBAAe,EAAC,GAAG,CAAC,UAAU,CAAC,CAAC;KAC1D;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kBAAe;IACb,WAAW;CACZ,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  appendCustomParams,\n  ILocation,\n  IPoint,\n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_SERVICE_AREA_URL,\n  IEndpointOptions,\n  normalizeLocationsList,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\nexport interface IServiceAreaOptions extends IEndpointOptions {\n  /**\n   *  Specify one or more locations around which service areas are generated.\n   */\n  facilities: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify if the service should return routes.\n   */\n  travelDirection?: \"incidentsToFacilities\" | \"facilitiesToIncidents\";\n  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  outputLines?: boolean;\n  returnFacilities?: boolean;\n  returnBarriers?: boolean;\n  returnPolylineBarriers?: boolean;\n  returnPolygonBarriers?: boolean;\n  preserveObjectID?: boolean;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: any;\n}\n\nexport interface IServiceAreaResponse {\n  messages: string[];\n  saPolygons?: IFeatureSetWithGeoJson;\n  incidents?: IFeatureSet;\n  facilities?: IFeatureSet;\n  barriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n}\n\nfunction getTravelDirection(\n  key: \"incidentsToFacilities\" | \"facilitiesToIncidents\"\n): \"esriNATravelDirectionFromFacility\" | \"esriNATravelDirectionToFacility\" {\n  if (key === \"incidentsToFacilities\") {\n    return \"esriNATravelDirectionFromFacility\";\n  } else {\n    return \"esriNATravelDirectionToFacility\";\n  }\n}\n\n/**\n * Used to find the area that can be reached from the input location within a given travel time or travel distance. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm) for more information.\n *\n * ```js\n * import { serviceArea } from '@esri/arcgis-rest-routing';\n *\n * serviceArea({\n *   facilities: [\n *     [-90.444716, 38.635501],\n *     [-90.311919, 38.633523],\n *     [-90.451147, 38.581107]\n *    ],\n *    authentication\n * })\n *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}\n * ```\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with service area polygons for the request.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm\n */\nexport function serviceArea(\n  requestOptions: IServiceAreaOptions\n): Promise<IServiceAreaResponse> {\n  const endpoint = requestOptions.endpoint || ARCGIS_ONLINE_SERVICE_AREA_URL;\n\n  requestOptions.params = {\n    returnFacilities: true,\n    returnBarriers: true,\n    returnPolylineBarriers: true,\n    returnPolygonBarriers: true,\n    preserveObjectID: true,\n    ...requestOptions.params\n  };\n\n  const options = appendCustomParams<IServiceAreaOptions>(requestOptions, [\n    \"barriers\",\n    \"polylineBarriers\",\n    \"polygonBarriers\",\n    \"outputLines\",\n    \"returnFacilities\",\n    \"returnBarriers\",\n    \"returnPolylineBarriers\",\n    \"returnPolygonBarriers\",\n    \"preserveObjectID\"\n  ]);\n\n  // Set travelDirection\n  if (requestOptions.travelDirection) {\n    options.params.travelDirection = getTravelDirection(\n      requestOptions.travelDirection\n    );\n  }\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    endpoint === ARCGIS_ONLINE_SERVICE_AREA_URL\n  ) {\n    return Promise.reject(\n      \"Finding service areas using the ArcGIS service requires authentication\"\n    );\n  }\n\n  if (isFeatureSet(requestOptions.facilities)) {\n    options.params.facilities = requestOptions.facilities;\n  } else {\n    options.params.facilities = normalizeLocationsList(\n      requestOptions.facilities\n    ).join(\";\");\n  }\n\n  // optional input param that may need point geometry normalizing\n  if (requestOptions.barriers) {\n    if (isFeatureSet(requestOptions.barriers)) {\n      options.params.barriers = requestOptions.barriers;\n    } else {\n      // optional point geometry barriers must be normalized, too\n      // but not if provided as IFeatureSet type\n      // note that optional polylineBarriers and polygonBarriers do not need to be normalized\n      options.params.barriers = normalizeLocationsList(\n        requestOptions.barriers\n      ).join(\";\");\n    }\n  }\n\n  return request(`${cleanUrl(endpoint)}/solveServiceArea`, options).then(\n    cleanResponse\n  );\n}\n\nfunction cleanResponse(res: any): IServiceAreaResponse {\n  // remove \"fieldAliases\" because it does not do anything.\n  delete res.saPolygons.fieldAliases;\n\n  // add \"geoJson\" property to \"saPolygons\"\n  if (res.saPolygons.spatialReference.wkid === 4326) {\n    res.saPolygons.geoJson = arcgisToGeoJSON(res.saPolygons);\n  }\n  return res;\n}\n\nexport default {\n  serviceArea\n};\n"]}

package/dist/cjs/solveRoute.js

@@ -15,9 +15,11 @@ function isLocation(coords) {
         coords.lat !== undefined);
 }
 /**
+ * Used to find the best way to get from one location to another or to visit several locations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/route-synchronous-service.htm) for more information.
+ *
  * ```js
  * import { solveRoute } from '@esri/arcgis-rest-routing';
- * //
+ *
  * solveRoute({
  *   stops: [
  *     [-117.195677, 34.056383],
@@ -27,7 +29,6 @@ function isLocation(coords) {
  * })
  *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}
  * ```
- * Used to find the best way to get from one location to another or to visit several locations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/route-synchronous-service.htm) for more information.
  *
  * @param requestOptions Options to pass through to the routing service.
  * @returns A Promise that will resolve with routes and directions for the request.

package/dist/cjs/solveRoute.js.map

@@ -1 +1 @@
-{"version":3,"file":"solveRoute.js","sourceRoot":"","sources":["../../src/solveRoute.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,mEAOmC;AAEnC,6CAKsB;AAEtB,gDAAsD;AA+BtD,SAAS,eAAe,CACtB,MAAwE;IAExE,OAAO,CACJ,MAA2B,CAAC,MAAM,KAAK,CAAC;QACxC,MAAmC,CAAC,MAAM,KAAK,CAAC,CAClD,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CACjB,MAAwE;IAExE,OAAO,CACJ,MAAoB,CAAC,QAAQ,KAAK,SAAS;QAC3C,MAAoB,CAAC,GAAG,KAAK,SAAS,CACxC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,UAAU,CACxB,cAAkC;IAElC,MAAM,OAAO,mBACX,QAAQ,EAAE,cAAc,CAAC,QAAQ,IAAI,sCAAyB,EAC9D,MAAM,EAAE,EAAE,IACP,cAAc,CAClB,CAAC;IAEF,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,OAAO,CAAC,QAAQ,KAAK,sCAAyB,EAC9C;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,0DAA0D,CAC3D,CAAC;KACH;IAED,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,KAAK,CAAC,EAAE;QACtC,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC;KAC7C;SAAM;QACL,MAAM,KAAK,GAAa,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1D,IAAI,eAAe,CAAC,MAAM,CAAC,EAAE;gBAC3B,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;aACtB;iBAAM,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE;gBAC7B,IAAI,MAAM,CAAC,GAAG,EAAE;oBACd,OAAO,CACL,MAAM,CAAC,IAAI,GAAG,GAAG,GAAG,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAClE,CAAC;iBACH;qBAAM;oBACL,OAAO,CACL,MAAM,CAAC,SAAS;wBAChB,GAAG;wBACH,MAAM,CAAC,QAAQ;wBACf,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACjC,CAAC;iBACH;aACF;iBAAM;gBACL,OAAO,MAAM,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;aACrE;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACxC;IAED,OAAO,IAAA,6BAAO,EAAC,GAAG,IAAA,8BAAQ,EAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CACjE,aAAa,CACd,CAAC;AACJ,CAAC;AAjDD,gCAiDC;AAED,SAAS,aAAa,CAAC,GAAQ;IAC7B,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;QAC/C,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,CACjC,CAAC,SAKA,EAAE,EAAE;YACH,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CACzC,CAAC,OAAuC,EAAE,EAAE;gBAC1C,OAAO,CAAC,QAAQ,GAAG,IAAA,+BAAkB,EAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;gBAClE,OAAO,OAAO,CAAC;YACjB,CAAC,CACF,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC,CACF,CAAC;KACH;IAED,qCAAqC;IACrC,IAAI,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC7C,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAY,EAAE,EAAE;YACxD,OAAO;gBACL,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,IAAA,wBAAe,EAAC,OAAO,CAAC,QAAQ,CAAC;gBAC3C,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,UAAU,CAAC;aAClD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,MAAM,CAAC,OAAO,GAAG;YACnB,IAAI,EAAE,mBAAmB;YACzB,QAAQ;SACT,CAAC;KACH;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kBAAe;IACb,UAAU;CACX,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\r\n * Apache-2.0 */\r\n\r\nimport { \r\n  request, \r\n  cleanUrl, \r\n  ILocation,\r\n  IPoint,\r\n  IFeature,\r\n  IFeatureSet\r\n} from \"@esri/arcgis-rest-request\";\r\n\r\nimport {\r\n  ARCGIS_ONLINE_ROUTING_URL,\r\n  IEndpointOptions,\r\n  decompressGeometry,\r\n  isFeatureSet\r\n} from \"./helpers.js\";\r\n\r\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\r\n\r\ninterface IFeatureWithCompressedGeometry extends IFeature {\r\n  compressedGeometry?: string;\r\n}\r\n\r\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\r\n  geoJson?: {};\r\n}\r\n\r\nexport interface ISolveRouteOptions extends IEndpointOptions {\r\n  /**\r\n   * Specify two or more locations between which the route is to be found.\r\n   */\r\n  stops:\r\n  | Array<IPoint | ILocation | [number, number] | [number, number, number]>\r\n  | IFeatureSet;\r\n}\r\n\r\nexport interface ISolveRouteResponse {\r\n  messages: string[];\r\n  checksum: string;\r\n  routes: IFeatureSetWithGeoJson;\r\n  directions?: Array<{\r\n    routeId: number;\r\n    routeName: string;\r\n    summary: object;\r\n    features: IFeature[];\r\n  }>;\r\n}\r\n\r\nfunction isLocationArray(\r\n  coords: ILocation | IPoint | [number, number] | [number, number, number]\r\n): coords is [number, number] | [number, number, number] {\r\n  return (\r\n    (coords as [number, number]).length === 2 ||\r\n    (coords as [number, number, number]).length === 3\r\n  );\r\n}\r\n\r\nfunction isLocation(\r\n  coords: ILocation | IPoint | [number, number] | [number, number, number]\r\n): coords is ILocation {\r\n  return (\r\n    (coords as ILocation).latitude !== undefined ||\r\n    (coords as ILocation).lat !== undefined\r\n  );\r\n}\r\n\r\n/**\r\n * ```js\r\n * import { solveRoute } from '@esri/arcgis-rest-routing';\r\n * //\r\n * solveRoute({\r\n *   stops: [\r\n *     [-117.195677, 34.056383],\r\n *     [-117.918976, 33.812092],\r\n *    ],\r\n *    authentication\r\n * })\r\n *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}\r\n * ```\r\n * Used to find the best way to get from one location to another or to visit several locations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/route-synchronous-service.htm) for more information.\r\n *\r\n * @param requestOptions Options to pass through to the routing service.\r\n * @returns A Promise that will resolve with routes and directions for the request.\r\n * @restlink https://developers.arcgis.com/rest/network/api-reference/route-synchronous-service.htm\r\n */\r\nexport function solveRoute(\r\n  requestOptions: ISolveRouteOptions\r\n): Promise<ISolveRouteResponse> {\r\n  const options: ISolveRouteOptions = {\r\n    endpoint: requestOptions.endpoint || ARCGIS_ONLINE_ROUTING_URL,\r\n    params: {},\r\n    ...requestOptions\r\n  };\r\n\r\n  // the SAAS service does not support anonymous requests\r\n  if (\r\n    !requestOptions.authentication &&\r\n    options.endpoint === ARCGIS_ONLINE_ROUTING_URL\r\n  ) {\r\n    return Promise.reject(\r\n      \"Routing using the ArcGIS service requires authentication\"\r\n    );\r\n  }\r\n\r\n  if (isFeatureSet(requestOptions.stops)) {\r\n    options.params.stops = requestOptions.stops;\r\n  } else {\r\n    const stops: string[] = requestOptions.stops.map((coords) => {\r\n      if (isLocationArray(coords)) {\r\n        return coords.join();\r\n      } else if (isLocation(coords)) {\r\n        if (coords.lat) {\r\n          return (\r\n            coords.long + \",\" + coords.lat + (coords.z ? \",\" + coords.z : \"\")\r\n          );\r\n        } else {\r\n          return (\r\n            coords.longitude +\r\n            \",\" +\r\n            coords.latitude +\r\n            (coords.z ? \",\" + coords.z : \"\")\r\n          );\r\n        }\r\n      } else {\r\n        return coords.x + \",\" + coords.y + (coords.z ? \",\" + coords.z : \"\");\r\n      }\r\n    });\r\n\r\n    options.params.stops = stops.join(\";\");\r\n  }\r\n\r\n  return request(`${cleanUrl(options.endpoint)}/solve`, options).then(\r\n    cleanResponse\r\n  );\r\n}\r\n\r\nfunction cleanResponse(res: any): ISolveRouteResponse {\r\n  if (res.directions && res.directions.length > 0) {\r\n    res.directions = res.directions.map(\r\n      (direction: {\r\n        features: IFeatureWithCompressedGeometry[];\r\n        routeId: number;\r\n        routeName: string;\r\n        summary: {};\r\n      }) => {\r\n        direction.features = direction.features.map(\r\n          (feature: IFeatureWithCompressedGeometry) => {\r\n            feature.geometry = decompressGeometry(feature.compressedGeometry);\r\n            return feature;\r\n          }\r\n        );\r\n        return direction;\r\n      }\r\n    );\r\n  }\r\n\r\n  // add \"geoJson\" property to \"routes\"\r\n  if (res.routes.spatialReference.wkid === 4326) {\r\n    const features = res.routes.features.map((feature: any) => {\r\n      return {\r\n        type: \"Feature\",\r\n        geometry: arcgisToGeoJSON(feature.geometry),\r\n        properties: Object.assign({}, feature.attributes)\r\n      };\r\n    });\r\n\r\n    res.routes.geoJson = {\r\n      type: \"FeatureCollection\",\r\n      features\r\n    };\r\n  }\r\n  return res;\r\n}\r\n\r\nexport default {\r\n  solveRoute\r\n};\r\n"]}
+{"version":3,"file":"solveRoute.js","sourceRoot":"","sources":["../../src/solveRoute.ts"],"names":[],"mappings":";AAAA;gBACgB;;;AAEhB,mEAOmC;AAEnC,6CAKsB;AAEtB,gDAAsD;AA+BtD,SAAS,eAAe,CACtB,MAAwE;IAExE,OAAO,CACJ,MAA2B,CAAC,MAAM,KAAK,CAAC;QACxC,MAAmC,CAAC,MAAM,KAAK,CAAC,CAClD,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CACjB,MAAwE;IAExE,OAAO,CACJ,MAAoB,CAAC,QAAQ,KAAK,SAAS;QAC3C,MAAoB,CAAC,GAAG,KAAK,SAAS,CACxC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,UAAU,CACxB,cAAkC;IAElC,MAAM,OAAO,mBACX,QAAQ,EAAE,cAAc,CAAC,QAAQ,IAAI,sCAAyB,EAC9D,MAAM,EAAE,EAAE,IACP,cAAc,CAClB,CAAC;IAEF,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,OAAO,CAAC,QAAQ,KAAK,sCAAyB,EAC9C;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,0DAA0D,CAC3D,CAAC;KACH;IAED,IAAI,IAAA,yBAAY,EAAC,cAAc,CAAC,KAAK,CAAC,EAAE;QACtC,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC;KAC7C;SAAM;QACL,MAAM,KAAK,GAAa,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1D,IAAI,eAAe,CAAC,MAAM,CAAC,EAAE;gBAC3B,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;aACtB;iBAAM,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE;gBAC7B,IAAI,MAAM,CAAC,GAAG,EAAE;oBACd,OAAO,CACL,MAAM,CAAC,IAAI,GAAG,GAAG,GAAG,MAAM,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAClE,CAAC;iBACH;qBAAM;oBACL,OAAO,CACL,MAAM,CAAC,SAAS;wBAChB,GAAG;wBACH,MAAM,CAAC,QAAQ;wBACf,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CACjC,CAAC;iBACH;aACF;iBAAM;gBACL,OAAO,MAAM,CAAC,CAAC,GAAG,GAAG,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;aACrE;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACxC;IAED,OAAO,IAAA,6BAAO,EAAC,GAAG,IAAA,8BAAQ,EAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CACjE,aAAa,CACd,CAAC;AACJ,CAAC;AAjDD,gCAiDC;AAED,SAAS,aAAa,CAAC,GAAQ;IAC7B,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;QAC/C,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,CACjC,CAAC,SAKA,EAAE,EAAE;YACH,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,CACzC,CAAC,OAAuC,EAAE,EAAE;gBAC1C,OAAO,CAAC,QAAQ,GAAG,IAAA,+BAAkB,EAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;gBAClE,OAAO,OAAO,CAAC;YACjB,CAAC,CACF,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC,CACF,CAAC;KACH;IAED,qCAAqC;IACrC,IAAI,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC7C,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAY,EAAE,EAAE;YACxD,OAAO;gBACL,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,IAAA,wBAAe,EAAC,OAAO,CAAC,QAAQ,CAAC;gBAC3C,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,UAAU,CAAC;aAClD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,MAAM,CAAC,OAAO,GAAG;YACnB,IAAI,EAAE,mBAAmB;YACzB,QAAQ;SACT,CAAC;KACH;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kBAAe;IACb,UAAU;CACX,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  ILocation,\n  IPoint,\n  IFeature,\n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_ROUTING_URL,\n  IEndpointOptions,\n  decompressGeometry,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\ninterface IFeatureWithCompressedGeometry extends IFeature {\n  compressedGeometry?: string;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: {};\n}\n\nexport interface ISolveRouteOptions extends IEndpointOptions {\n  /**\n   * Specify two or more locations between which the route is to be found.\n   */\n  stops:\n    | Array<IPoint | ILocation | [number, number] | [number, number, number]>\n    | IFeatureSet;\n}\n\nexport interface ISolveRouteResponse {\n  messages: string[];\n  checksum: string;\n  routes: IFeatureSetWithGeoJson;\n  directions?: Array<{\n    routeId: number;\n    routeName: string;\n    summary: object;\n    features: IFeature[];\n  }>;\n}\n\nfunction isLocationArray(\n  coords: ILocation | IPoint | [number, number] | [number, number, number]\n): coords is [number, number] | [number, number, number] {\n  return (\n    (coords as [number, number]).length === 2 ||\n    (coords as [number, number, number]).length === 3\n  );\n}\n\nfunction isLocation(\n  coords: ILocation | IPoint | [number, number] | [number, number, number]\n): coords is ILocation {\n  return (\n    (coords as ILocation).latitude !== undefined ||\n    (coords as ILocation).lat !== undefined\n  );\n}\n\n/**\n * Used to find the best way to get from one location to another or to visit several locations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/route-synchronous-service.htm) for more information.\n *\n * ```js\n * import { solveRoute } from '@esri/arcgis-rest-routing';\n *\n * solveRoute({\n *   stops: [\n *     [-117.195677, 34.056383],\n *     [-117.918976, 33.812092],\n *    ],\n *    authentication\n * })\n *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}\n * ```\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with routes and directions for the request.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/route-synchronous-service.htm\n */\nexport function solveRoute(\n  requestOptions: ISolveRouteOptions\n): Promise<ISolveRouteResponse> {\n  const options: ISolveRouteOptions = {\n    endpoint: requestOptions.endpoint || ARCGIS_ONLINE_ROUTING_URL,\n    params: {},\n    ...requestOptions\n  };\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    options.endpoint === ARCGIS_ONLINE_ROUTING_URL\n  ) {\n    return Promise.reject(\n      \"Routing using the ArcGIS service requires authentication\"\n    );\n  }\n\n  if (isFeatureSet(requestOptions.stops)) {\n    options.params.stops = requestOptions.stops;\n  } else {\n    const stops: string[] = requestOptions.stops.map((coords) => {\n      if (isLocationArray(coords)) {\n        return coords.join();\n      } else if (isLocation(coords)) {\n        if (coords.lat) {\n          return (\n            coords.long + \",\" + coords.lat + (coords.z ? \",\" + coords.z : \"\")\n          );\n        } else {\n          return (\n            coords.longitude +\n            \",\" +\n            coords.latitude +\n            (coords.z ? \",\" + coords.z : \"\")\n          );\n        }\n      } else {\n        return coords.x + \",\" + coords.y + (coords.z ? \",\" + coords.z : \"\");\n      }\n    });\n\n    options.params.stops = stops.join(\";\");\n  }\n\n  return request(`${cleanUrl(options.endpoint)}/solve`, options).then(\n    cleanResponse\n  );\n}\n\nfunction cleanResponse(res: any): ISolveRouteResponse {\n  if (res.directions && res.directions.length > 0) {\n    res.directions = res.directions.map(\n      (direction: {\n        features: IFeatureWithCompressedGeometry[];\n        routeId: number;\n        routeName: string;\n        summary: {};\n      }) => {\n        direction.features = direction.features.map(\n          (feature: IFeatureWithCompressedGeometry) => {\n            feature.geometry = decompressGeometry(feature.compressedGeometry);\n            return feature;\n          }\n        );\n        return direction;\n      }\n    );\n  }\n\n  // add \"geoJson\" property to \"routes\"\n  if (res.routes.spatialReference.wkid === 4326) {\n    const features = res.routes.features.map((feature: any) => {\n      return {\n        type: \"Feature\",\n        geometry: arcgisToGeoJSON(feature.geometry),\n        properties: Object.assign({}, feature.attributes)\n      };\n    });\n\n    res.routes.geoJson = {\n      type: \"FeatureCollection\",\n      features\n    };\n  }\n  return res;\n}\n\nexport default {\n  solveRoute\n};\n"]}

package/dist/esm/closestFacility.d.ts

@@ -47,9 +47,11 @@ export interface IClosestFacilityResponse {
     polylineBarriers?: IFeatureSet;
 }
 /**
+ * Used to find a route to the nearest of several possible destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm) for more information.
+ *
  * ```js
  * import { closestFacility } from '@esri/arcgis-rest-routing';
- * //
+ *
  * closestFacility({
  *   incidents: [
  *     [-90.404302, 38.600621],
@@ -64,7 +66,6 @@ export interface IClosestFacilityResponse {
  * })
  *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}
  * ```
- * Used to find a route to the nearest of several possible destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm) for more information.
  *
  * @param requestOptions Options to pass through to the routing service.
  * @returns A Promise that will resolve with routes and directions for the request.

package/dist/esm/closestFacility.js

@@ -12,9 +12,11 @@ function getTravelDirection(key) {
     }
 }
 /**
+ * Used to find a route to the nearest of several possible destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm) for more information.
+ *
  * ```js
  * import { closestFacility } from '@esri/arcgis-rest-routing';
- * //
+ *
  * closestFacility({
  *   incidents: [
  *     [-90.404302, 38.600621],
@@ -29,7 +31,6 @@ function getTravelDirection(key) {
  * })
  *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}
  * ```
- * Used to find a route to the nearest of several possible destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm) for more information.
  *
  * @param requestOptions Options to pass through to the routing service.
  * @returns A Promise that will resolve with routes and directions for the request.

package/dist/esm/closestFacility.js.map

@@ -1 +1 @@
-{"version":3,"file":"closestFacility.js","sourceRoot":"","sources":["../../src/closestFacility.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EACL,OAAO,EACP,QAAQ,EACR,kBAAkB,EAKnB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACL,kCAAkC,EAElC,sBAAsB,EACtB,YAAY,EACb,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAsEtD,SAAS,kBAAkB,CACzB,GAAsD;IAEtD,IAAI,GAAG,KAAK,uBAAuB,EAAE;QACnC,OAAO,mCAAmC,CAAC;KAC5C;SAAM;QACL,OAAO,iCAAiC,CAAC;KAC1C;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,eAAe,CAC7B,cAAuC;IAEvC,MAAM,QAAQ,GACZ,cAAc,CAAC,QAAQ,IAAI,kCAAkC,CAAC;IAEhE,cAAc,CAAC,MAAM,mBACnB,gBAAgB,EAAE,IAAI,EACtB,gBAAgB,EAAE,IAAI,EACtB,eAAe,EAAE,IAAI,EACrB,cAAc,EAAE,IAAI,EACpB,sBAAsB,EAAE,IAAI,EAC5B,qBAAqB,EAAE,IAAI,EAC3B,gBAAgB,EAAE,IAAI,IACnB,cAAc,CAAC,MAAM,CACzB,CAAC;IAEF,MAAM,OAAO,GAAG,kBAAkB,CAA0B,cAAc,EAAE;QAC1E,gBAAgB;QAChB,qBAAqB;QACrB,UAAU;QACV,kBAAkB;QAClB,iBAAiB;QACjB,kBAAkB;QAClB,sBAAsB;QACtB,uBAAuB;QACvB,aAAa;QACb,kBAAkB;QAClB,iBAAiB;QACjB,gBAAgB;QAChB,wBAAwB;QACxB,uBAAuB;QACvB,kBAAkB;KACnB,CAAC,CAAC;IAEH,sBAAsB;IACtB,IAAI,cAAc,CAAC,eAAe,EAAE;QAClC,OAAO,CAAC,MAAM,CAAC,eAAe,GAAG,kBAAkB,CACjD,cAAc,CAAC,eAAe,CAC/B,CAAC;KACH;IAED,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,QAAQ,KAAK,kCAAkC,EAC/C;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,+EAA+E,CAChF,CAAC;KACH;IAED,IAAI,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE;QAC1C,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC;KACrD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,sBAAsB,CAC/C,cAAc,CAAC,SAAS,CACzB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,IAAI,YAAY,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QAC3C,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC;KACvD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,sBAAsB,CAChD,cAAc,CAAC,UAAU,CAC1B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,gEAAgE;IAChE,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,IAAI,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SACnD;aAAM;YACL,2DAA2D;YAC3D,0CAA0C;YAC1C,uFAAuF;YACvF,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,sBAAsB,CAC9C,cAAc,CAAC,QAAQ,CACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACb;KACF;IAED,OAAO,OAAO,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC,IAAI,CACxE,aAAa,CACd,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,GAAQ;IAC7B,qCAAqC;IACrC,IAAI,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC7C,GAAG,CAAC,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KAClD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,eAAe;IACb,eAAe;CAChB,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  appendCustomParams,\n  ILocation,\n  IPoint,\n  IFeature,\n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_CLOSEST_FACILITY_URL,\n  IEndpointOptions,\n  normalizeLocationsList,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\nexport interface IClosestFacilityOptions extends IEndpointOptions {\n  /**\n   * Specify one or more locations from which the service searches for the nearby locations. These locations are referred to as incidents.\n   */\n  incidents: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n\n  /**\n   * Specify one or more locations that are searched for when finding the closest location.\n   */\n  facilities: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify if the service should return routes.\n   */\n  returnCFRoutes: boolean;\n  travelDirection?: \"incidentsToFacilities\" | \"facilitiesToIncidents\";\n  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  returnDirections?: boolean;\n  directionsOutputType?:\n    | \"esriDOTComplete\"\n    | \"esriDOTCompleteNoEvents\"\n    | \"esriDOTInstructionsOnly\"\n    | \"esriDOTStandard\"\n    | \"esriDOTSummaryOnly\"\n    | \"esriDOTFeatureSets\";\n  directionsLengthUnits?:\n    | \"esriNAUCentimeters\"\n    | \"esriNAUDecimalDegrees\"\n    | \"esriNAUDecimeters\"\n    | \"esriNAUFeet\"\n    | \"esriNAUInches\"\n    | \"esriNAUKilometers\"\n    | \"esriNAUMeters\"\n    | \"esriNAUMiles\"\n    | \"esriNAUMillimeters\"\n    | \"esriNAUNauticalMiles\"\n    | \"esriNAUPoints\"\n    | \"esriNAUYards\";\n  outputLines?: boolean;\n  returnFacilities?: boolean;\n  returnIncidents?: boolean;\n  returnBarriers?: boolean;\n  returnPolylineBarriers?: boolean;\n  returnPolygonBarriers?: boolean;\n  preserveObjectID?: boolean;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: any;\n}\n\nexport interface IClosestFacilityResponse {\n  messages: string[];\n  routes?: IFeatureSetWithGeoJson;\n  directions?: Array<{\n    routeId: number;\n    routeName: string;\n    summary: object;\n    features: IFeature[];\n  }>;\n  incidents?: IFeatureSet;\n  facilities?: IFeatureSet;\n  barriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n}\n\nfunction getTravelDirection(\n  key: \"incidentsToFacilities\" | \"facilitiesToIncidents\"\n): \"esriNATravelDirectionFromFacility\" | \"esriNATravelDirectionToFacility\" {\n  if (key === \"incidentsToFacilities\") {\n    return \"esriNATravelDirectionFromFacility\";\n  } else {\n    return \"esriNATravelDirectionToFacility\";\n  }\n}\n\n/**\n * ```js\n * import { closestFacility } from '@esri/arcgis-rest-routing';\n * //\n * closestFacility({\n *   incidents: [\n *     [-90.404302, 38.600621],\n *     [-90.364293, 38.620427],\n *    ],\n *   facilities: [\n *     [-90.444716, 38.635501],\n *     [-90.311919, 38.633523],\n *     [-90.451147, 38.581107]\n *    ],\n *    authentication\n * })\n *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}\n * ```\n * Used to find a route to the nearest of several possible destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm) for more information.\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with routes and directions for the request.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm\n * @inline IClosestFacilityOptions\n */\nexport function closestFacility(\n  requestOptions: IClosestFacilityOptions\n): Promise<IClosestFacilityResponse> {\n  const endpoint =\n    requestOptions.endpoint || ARCGIS_ONLINE_CLOSEST_FACILITY_URL;\n\n  requestOptions.params = {\n    returnFacilities: true,\n    returnDirections: true,\n    returnIncidents: true,\n    returnBarriers: true,\n    returnPolylineBarriers: true,\n    returnPolygonBarriers: true,\n    preserveObjectID: true,\n    ...requestOptions.params\n  };\n\n  const options = appendCustomParams<IClosestFacilityOptions>(requestOptions, [\n    \"returnCFRoutes\",\n    // \"travelDirection\",\n    \"barriers\",\n    \"polylineBarriers\",\n    \"polygonBarriers\",\n    \"returnDirections\",\n    \"directionsOutputType\",\n    \"directionsLengthUnits\",\n    \"outputLines\",\n    \"returnFacilities\",\n    \"returnIncidents\",\n    \"returnBarriers\",\n    \"returnPolylineBarriers\",\n    \"returnPolygonBarriers\",\n    \"preserveObjectID\"\n  ]);\n\n  // Set travelDirection\n  if (requestOptions.travelDirection) {\n    options.params.travelDirection = getTravelDirection(\n      requestOptions.travelDirection\n    );\n  }\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    endpoint === ARCGIS_ONLINE_CLOSEST_FACILITY_URL\n  ) {\n    return Promise.reject(\n      \"Finding the closest facility using the ArcGIS service requires authentication\"\n    );\n  }\n\n  if (isFeatureSet(requestOptions.incidents)) {\n    options.params.incidents = requestOptions.incidents;\n  } else {\n    options.params.incidents = normalizeLocationsList(\n      requestOptions.incidents\n    ).join(\";\");\n  }\n\n  if (isFeatureSet(requestOptions.facilities)) {\n    options.params.facilities = requestOptions.facilities;\n  } else {\n    options.params.facilities = normalizeLocationsList(\n      requestOptions.facilities\n    ).join(\";\");\n  }\n\n  // optional input param that may need point geometry normalizing\n  if (requestOptions.barriers) {\n    if (isFeatureSet(requestOptions.barriers)) {\n      options.params.barriers = requestOptions.barriers;\n    } else {\n      // optional point geometry barriers must be normalized, too\n      // but not if provided as IFeatureSet type\n      // note that optional polylineBarriers and polygonBarriers do not need to be normalized\n      options.params.barriers = normalizeLocationsList(\n        requestOptions.barriers\n      ).join(\";\");\n    }\n  }\n\n  return request(`${cleanUrl(endpoint)}/solveClosestFacility`, options).then(\n    cleanResponse\n  );\n}\n\nfunction cleanResponse(res: any): IClosestFacilityResponse {\n  // add \"geoJson\" property to \"routes\"\n  if (res.routes.spatialReference.wkid === 4326) {\n    res.routes.geoJson = arcgisToGeoJSON(res.routes);\n  }\n  return res;\n}\n\nexport default {\n  closestFacility\n};\n"]}
+{"version":3,"file":"closestFacility.js","sourceRoot":"","sources":["../../src/closestFacility.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EACL,OAAO,EACP,QAAQ,EACR,kBAAkB,EAKnB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACL,kCAAkC,EAElC,sBAAsB,EACtB,YAAY,EACb,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAsEtD,SAAS,kBAAkB,CACzB,GAAsD;IAEtD,IAAI,GAAG,KAAK,uBAAuB,EAAE;QACnC,OAAO,mCAAmC,CAAC;KAC5C;SAAM;QACL,OAAO,iCAAiC,CAAC;KAC1C;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,UAAU,eAAe,CAC7B,cAAuC;IAEvC,MAAM,QAAQ,GACZ,cAAc,CAAC,QAAQ,IAAI,kCAAkC,CAAC;IAEhE,cAAc,CAAC,MAAM,mBACnB,gBAAgB,EAAE,IAAI,EACtB,gBAAgB,EAAE,IAAI,EACtB,eAAe,EAAE,IAAI,EACrB,cAAc,EAAE,IAAI,EACpB,sBAAsB,EAAE,IAAI,EAC5B,qBAAqB,EAAE,IAAI,EAC3B,gBAAgB,EAAE,IAAI,IACnB,cAAc,CAAC,MAAM,CACzB,CAAC;IAEF,MAAM,OAAO,GAAG,kBAAkB,CAA0B,cAAc,EAAE;QAC1E,gBAAgB;QAChB,qBAAqB;QACrB,UAAU;QACV,kBAAkB;QAClB,iBAAiB;QACjB,kBAAkB;QAClB,sBAAsB;QACtB,uBAAuB;QACvB,aAAa;QACb,kBAAkB;QAClB,iBAAiB;QACjB,gBAAgB;QAChB,wBAAwB;QACxB,uBAAuB;QACvB,kBAAkB;KACnB,CAAC,CAAC;IAEH,sBAAsB;IACtB,IAAI,cAAc,CAAC,eAAe,EAAE;QAClC,OAAO,CAAC,MAAM,CAAC,eAAe,GAAG,kBAAkB,CACjD,cAAc,CAAC,eAAe,CAC/B,CAAC;KACH;IAED,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,QAAQ,KAAK,kCAAkC,EAC/C;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,+EAA+E,CAChF,CAAC;KACH;IAED,IAAI,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE;QAC1C,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC;KACrD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,sBAAsB,CAC/C,cAAc,CAAC,SAAS,CACzB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,IAAI,YAAY,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QAC3C,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC;KACvD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,sBAAsB,CAChD,cAAc,CAAC,UAAU,CAC1B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,gEAAgE;IAChE,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,IAAI,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SACnD;aAAM;YACL,2DAA2D;YAC3D,0CAA0C;YAC1C,uFAAuF;YACvF,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,sBAAsB,CAC9C,cAAc,CAAC,QAAQ,CACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACb;KACF;IAED,OAAO,OAAO,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC,IAAI,CACxE,aAAa,CACd,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,GAAQ;IAC7B,qCAAqC;IACrC,IAAI,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC7C,GAAG,CAAC,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KAClD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,eAAe;IACb,eAAe;CAChB,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  appendCustomParams,\n  ILocation,\n  IPoint,\n  IFeature,\n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_CLOSEST_FACILITY_URL,\n  IEndpointOptions,\n  normalizeLocationsList,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\nexport interface IClosestFacilityOptions extends IEndpointOptions {\n  /**\n   * Specify one or more locations from which the service searches for the nearby locations. These locations are referred to as incidents.\n   */\n  incidents: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n\n  /**\n   * Specify one or more locations that are searched for when finding the closest location.\n   */\n  facilities: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify if the service should return routes.\n   */\n  returnCFRoutes: boolean;\n  travelDirection?: \"incidentsToFacilities\" | \"facilitiesToIncidents\";\n  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  returnDirections?: boolean;\n  directionsOutputType?:\n    | \"esriDOTComplete\"\n    | \"esriDOTCompleteNoEvents\"\n    | \"esriDOTInstructionsOnly\"\n    | \"esriDOTStandard\"\n    | \"esriDOTSummaryOnly\"\n    | \"esriDOTFeatureSets\";\n  directionsLengthUnits?:\n    | \"esriNAUCentimeters\"\n    | \"esriNAUDecimalDegrees\"\n    | \"esriNAUDecimeters\"\n    | \"esriNAUFeet\"\n    | \"esriNAUInches\"\n    | \"esriNAUKilometers\"\n    | \"esriNAUMeters\"\n    | \"esriNAUMiles\"\n    | \"esriNAUMillimeters\"\n    | \"esriNAUNauticalMiles\"\n    | \"esriNAUPoints\"\n    | \"esriNAUYards\";\n  outputLines?: boolean;\n  returnFacilities?: boolean;\n  returnIncidents?: boolean;\n  returnBarriers?: boolean;\n  returnPolylineBarriers?: boolean;\n  returnPolygonBarriers?: boolean;\n  preserveObjectID?: boolean;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: any;\n}\n\nexport interface IClosestFacilityResponse {\n  messages: string[];\n  routes?: IFeatureSetWithGeoJson;\n  directions?: Array<{\n    routeId: number;\n    routeName: string;\n    summary: object;\n    features: IFeature[];\n  }>;\n  incidents?: IFeatureSet;\n  facilities?: IFeatureSet;\n  barriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n}\n\nfunction getTravelDirection(\n  key: \"incidentsToFacilities\" | \"facilitiesToIncidents\"\n): \"esriNATravelDirectionFromFacility\" | \"esriNATravelDirectionToFacility\" {\n  if (key === \"incidentsToFacilities\") {\n    return \"esriNATravelDirectionFromFacility\";\n  } else {\n    return \"esriNATravelDirectionToFacility\";\n  }\n}\n\n/**\n * Used to find a route to the nearest of several possible destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm) for more information.\n *\n * ```js\n * import { closestFacility } from '@esri/arcgis-rest-routing';\n *\n * closestFacility({\n *   incidents: [\n *     [-90.404302, 38.600621],\n *     [-90.364293, 38.620427],\n *    ],\n *   facilities: [\n *     [-90.444716, 38.635501],\n *     [-90.311919, 38.633523],\n *     [-90.451147, 38.581107]\n *    ],\n *    authentication\n * })\n *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}\n * ```\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with routes and directions for the request.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/closest-facility-synchronous-service.htm\n * @inline IClosestFacilityOptions\n */\nexport function closestFacility(\n  requestOptions: IClosestFacilityOptions\n): Promise<IClosestFacilityResponse> {\n  const endpoint =\n    requestOptions.endpoint || ARCGIS_ONLINE_CLOSEST_FACILITY_URL;\n\n  requestOptions.params = {\n    returnFacilities: true,\n    returnDirections: true,\n    returnIncidents: true,\n    returnBarriers: true,\n    returnPolylineBarriers: true,\n    returnPolygonBarriers: true,\n    preserveObjectID: true,\n    ...requestOptions.params\n  };\n\n  const options = appendCustomParams<IClosestFacilityOptions>(requestOptions, [\n    \"returnCFRoutes\",\n    // \"travelDirection\",\n    \"barriers\",\n    \"polylineBarriers\",\n    \"polygonBarriers\",\n    \"returnDirections\",\n    \"directionsOutputType\",\n    \"directionsLengthUnits\",\n    \"outputLines\",\n    \"returnFacilities\",\n    \"returnIncidents\",\n    \"returnBarriers\",\n    \"returnPolylineBarriers\",\n    \"returnPolygonBarriers\",\n    \"preserveObjectID\"\n  ]);\n\n  // Set travelDirection\n  if (requestOptions.travelDirection) {\n    options.params.travelDirection = getTravelDirection(\n      requestOptions.travelDirection\n    );\n  }\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    endpoint === ARCGIS_ONLINE_CLOSEST_FACILITY_URL\n  ) {\n    return Promise.reject(\n      \"Finding the closest facility using the ArcGIS service requires authentication\"\n    );\n  }\n\n  if (isFeatureSet(requestOptions.incidents)) {\n    options.params.incidents = requestOptions.incidents;\n  } else {\n    options.params.incidents = normalizeLocationsList(\n      requestOptions.incidents\n    ).join(\";\");\n  }\n\n  if (isFeatureSet(requestOptions.facilities)) {\n    options.params.facilities = requestOptions.facilities;\n  } else {\n    options.params.facilities = normalizeLocationsList(\n      requestOptions.facilities\n    ).join(\";\");\n  }\n\n  // optional input param that may need point geometry normalizing\n  if (requestOptions.barriers) {\n    if (isFeatureSet(requestOptions.barriers)) {\n      options.params.barriers = requestOptions.barriers;\n    } else {\n      // optional point geometry barriers must be normalized, too\n      // but not if provided as IFeatureSet type\n      // note that optional polylineBarriers and polygonBarriers do not need to be normalized\n      options.params.barriers = normalizeLocationsList(\n        requestOptions.barriers\n      ).join(\";\");\n    }\n  }\n\n  return request(`${cleanUrl(endpoint)}/solveClosestFacility`, options).then(\n    cleanResponse\n  );\n}\n\nfunction cleanResponse(res: any): IClosestFacilityResponse {\n  // add \"geoJson\" property to \"routes\"\n  if (res.routes.spatialReference.wkid === 4326) {\n    res.routes.geoJson = arcgisToGeoJSON(res.routes);\n  }\n  return res;\n}\n\nexport default {\n  closestFacility\n};\n"]}

package/dist/esm/originDestinationMatrix.d.ts

@@ -45,9 +45,11 @@ export interface IOriginDestinationMatrixResponse {
     polygonBarriers?: IFeatureSetWithGeoJson;
 }
 /**
+ * Used to create an origin-destination (OD) cost matrix from multiple origins to multiple destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm) for more information.
+ *
  * ```js
  * import { originDestinationMatrix } from '@esri/arcgis-rest-routing';
- * //
+ *
  * originDestinationMatrix({
  *   origins: [
  *     [-90.404302, 38.600621],
@@ -62,7 +64,6 @@ export interface IOriginDestinationMatrixResponse {
  * })
  *   .then(response) // => { ... }
  * ```
- * Used to create an origin-destination (OD) cost matrix from multiple origins to multiple destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm) for more information.
  *
  * @param requestOptions Options to pass through to the routing service.
  * @returns A Promise that will resolve with travel time and/or distance for each origin-destination pair. It returns either odLines or odCostMatrix for this information depending on the outputType you specify.

package/dist/esm/originDestinationMatrix.js

@@ -4,9 +4,11 @@ import { request, cleanUrl, appendCustomParams } from "@esri/arcgis-rest-request
 import { ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL, normalizeLocationsList, isFeatureSet } from "./helpers.js";
 import { arcgisToGeoJSON } from "@terraformer/arcgis";
 /**
+ * Used to create an origin-destination (OD) cost matrix from multiple origins to multiple destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm) for more information.
+ *
  * ```js
  * import { originDestinationMatrix } from '@esri/arcgis-rest-routing';
- * //
+ *
  * originDestinationMatrix({
  *   origins: [
  *     [-90.404302, 38.600621],
@@ -21,7 +23,6 @@ import { arcgisToGeoJSON } from "@terraformer/arcgis";
  * })
  *   .then(response) // => { ... }
  * ```
- * Used to create an origin-destination (OD) cost matrix from multiple origins to multiple destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm) for more information.
  *
  * @param requestOptions Options to pass through to the routing service.
  * @returns A Promise that will resolve with travel time and/or distance for each origin-destination pair. It returns either odLines or odCostMatrix for this information depending on the outputType you specify.

package/dist/esm/originDestinationMatrix.js.map

@@ -1 +1 @@
-{"version":3,"file":"originDestinationMatrix.js","sourceRoot":"","sources":["../../src/originDestinationMatrix.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EACL,OAAO,EACP,QAAQ,EACR,kBAAkB,EAKnB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACL,2CAA2C,EAE3C,sBAAsB,EACtB,YAAY,EACb,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAiDtD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,uBAAuB,CACrC,cAA+C;IAE/C,MAAM,QAAQ,GACZ,cAAc,CAAC,QAAQ,IAAI,2CAA2C,CAAC;IAEzE,cAAc,CAAC,MAAM,mBACnB,UAAU,EAAE,4BAA4B,EACxC,aAAa,EAAE,IAAI,EACnB,kBAAkB,EAAE,IAAI,EACxB,cAAc,EAAE,IAAI,EACpB,sBAAsB,EAAE,IAAI,EAC5B,qBAAqB,EAAE,IAAI,IACxB,cAAc,CAAC,MAAM,CACzB,CAAC;IAEF,MAAM,OAAO,GAAG,kBAAkB,CAChC,cAAc,EACd;QACE,YAAY;QACZ,UAAU;QACV,kBAAkB;QAClB,iBAAiB;QACjB,eAAe;QACf,oBAAoB;QACpB,gBAAgB;QAChB,wBAAwB;QACxB,uBAAuB;KACxB,CACF,CAAC;IAEF,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,QAAQ,KAAK,2CAA2C,EACxD;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,iGAAiG,CAClG,CAAC;KACH;IAED,sGAAsG;IACtG,IAAI,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE;QACxC,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;KACjD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,sBAAsB,CAC7C,cAAc,CAAC,OAAO,CACvB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,IAAI,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE;QAC7C,OAAO,CAAC,MAAM,CAAC,YAAY,GAAG,cAAc,CAAC,YAAY,CAAC;KAC3D;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,YAAY,GAAG,sBAAsB,CAClD,cAAc,CAAC,YAAY,CAC5B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,gEAAgE;IAChE,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,IAAI,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SACnD;aAAM;YACL,2DAA2D;YAC3D,0CAA0C;YAC1C,uFAAuF;YACvF,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,sBAAsB,CAC9C,cAAc,CAAC,QAAQ,CACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACb;KACF;IAED,OAAO,OAAO,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,IAAI,CACrE,UAAU,GAAG;QACX,OAAO,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC,CACF,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CACpB,GAAQ,EACR,OAAwB;IAExB,gFAAgF;IAEhF,gIAAgI;IAChI,IACE,OAAO,CAAC,MAAM,CAAC,UAAU,KAAK,6BAA6B;QAC3D,GAAG,CAAC,OAAO;QACX,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAC1C;QACA,GAAG,CAAC,OAAO,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KACpD;IAED,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC7D,GAAG,CAAC,OAAO,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KACpD;IAED,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QACvE,GAAG,CAAC,YAAY,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;KAC9D;IAED,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC/D,GAAG,CAAC,QAAQ,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;KACtD;IAED,IACE,GAAG,CAAC,eAAe;QACnB,GAAG,CAAC,eAAe,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAClD;QACA,GAAG,CAAC,eAAe,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;KACpE;IAED,IACE,GAAG,CAAC,gBAAgB;QACpB,GAAG,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EACnD;QACA,GAAG,CAAC,gBAAgB,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;KACtE;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,eAAe;IACb,uBAAuB;CACxB,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  appendCustomParams,\n  IRequestOptions,\n  ILocation, \n  IPoint, \n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL,\n  IEndpointOptions,\n  normalizeLocationsList,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\nexport interface IOriginDestinationMatrixOptions extends IEndpointOptions {\n  /**\n   *  Specify the starting points from which to travel to the destinations.\n   */\n  origins: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify the ending point locations to travel to from the origins.\n   */\n  destinations: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify the type of output returned by the service. Defaults to \"esriNAODOutputSparseMatrix\".\n   */\n  outputType?:\n    | \"esriNAODOutputSparseMatrix\"\n    | \"esriNAODOutputStraightLines\"\n    | \"esriNAODOutputNoLines\";\n  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  returnOrigins?: boolean;\n  returnDestinations?: boolean;\n  returnBarriers?: boolean;\n  returnPolylineBarriers?: boolean;\n  returnPolygonBarriers?: boolean;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: any;\n}\n\nexport interface IOriginDestinationMatrixResponse {\n  messages: [{ type: number; description: string }];\n  /**\n   *  Only present if outputType is \"esriNAODOutputSparseMatrix\". Full description is available at https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm#ESRI_SECTION2_114F8364507C4B56B780DFAD505270FB.\n   */\n  odCostMatrix?: any;\n  /**\n   *  Only present if outputType is \"esriNAODOutputStraightLines\" or \"esriNAODOutputNoLines\". Includes the geometry for the straight line connecting each origin-destination pair when the outputType is \"esriNAODOutputStraightLines\".\n   */\n  odLines?: IFeatureSetWithGeoJson;\n  origins?: IFeatureSetWithGeoJson;\n  destinations?: IFeatureSetWithGeoJson;\n  barriers?: IFeatureSetWithGeoJson;\n  polylineBarriers?: IFeatureSetWithGeoJson;\n  polygonBarriers?: IFeatureSetWithGeoJson;\n}\n\n/**\n * ```js\n * import { originDestinationMatrix } from '@esri/arcgis-rest-routing';\n * //\n * originDestinationMatrix({\n *   origins: [\n *     [-90.404302, 38.600621],\n *     [-90.364293, 38.620427],\n *   ],\n *   destinations: [\n *     [-90.444716, 38.635501],\n *     [-90.311919, 38.633523],\n *     [-90.451147, 38.581107]\n *   ],\n *   authentication\n * })\n *   .then(response) // => { ... }\n * ```\n * Used to create an origin-destination (OD) cost matrix from multiple origins to multiple destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm) for more information.\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with travel time and/or distance for each origin-destination pair. It returns either odLines or odCostMatrix for this information depending on the outputType you specify.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm\n */\nexport function originDestinationMatrix(\n  requestOptions: IOriginDestinationMatrixOptions\n): Promise<IOriginDestinationMatrixResponse> {\n  const endpoint =\n    requestOptions.endpoint || ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL;\n\n  requestOptions.params = {\n    outputType: \"esriNAODOutputSparseMatrix\",\n    returnOrigins: true,\n    returnDestinations: true,\n    returnBarriers: true,\n    returnPolylineBarriers: true,\n    returnPolygonBarriers: true,\n    ...requestOptions.params\n  };\n\n  const options = appendCustomParams<IOriginDestinationMatrixOptions>(\n    requestOptions,\n    [\n      \"outputType\",\n      \"barriers\",\n      \"polylineBarriers\",\n      \"polygonBarriers\",\n      \"returnOrigins\",\n      \"returnDestinations\",\n      \"returnBarriers\",\n      \"returnPolylineBarriers\",\n      \"returnPolygonBarriers\"\n    ]\n  );\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    endpoint === ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL\n  ) {\n    return Promise.reject(\n      \"Calculating the origin-destination cost matrix using the ArcGIS service requires authentication\"\n    );\n  }\n\n  // use a formatting helper for input params of this type: Array<IPoint | ILocation | [number, number]>\n  if (isFeatureSet(requestOptions.origins)) {\n    options.params.origins = requestOptions.origins;\n  } else {\n    options.params.origins = normalizeLocationsList(\n      requestOptions.origins\n    ).join(\";\");\n  }\n\n  if (isFeatureSet(requestOptions.destinations)) {\n    options.params.destinations = requestOptions.destinations;\n  } else {\n    options.params.destinations = normalizeLocationsList(\n      requestOptions.destinations\n    ).join(\";\");\n  }\n\n  // optional input param that may need point geometry normalizing\n  if (requestOptions.barriers) {\n    if (isFeatureSet(requestOptions.barriers)) {\n      options.params.barriers = requestOptions.barriers;\n    } else {\n      // optional point geometry barriers must be normalized, too\n      // but not if provided as IFeatureSet type\n      // note that optional polylineBarriers and polygonBarriers do not need to be normalized\n      options.params.barriers = normalizeLocationsList(\n        requestOptions.barriers\n      ).join(\";\");\n    }\n  }\n\n  return request(`${cleanUrl(endpoint)}/solveODCostMatrix`, options).then(\n    function (res) {\n      return cleanResponse(res, options);\n    }\n  );\n}\n\nfunction cleanResponse(\n  res: any,\n  options: IRequestOptions\n): IOriginDestinationMatrixResponse {\n  // add \"geoJson\" property to each response property that is an arcgis featureSet\n\n  // res.odLines only exists and only includes geometry in this condition (out of 3 possible options.params.outputType conditions)\n  if (\n    options.params.outputType === \"esriNAODOutputStraightLines\" &&\n    res.odLines &&\n    res.odLines.spatialReference.wkid === 4326\n  ) {\n    res.odLines.geoJson = arcgisToGeoJSON(res.odLines);\n  }\n\n  if (res.origins && res.origins.spatialReference.wkid === 4326) {\n    res.origins.geoJson = arcgisToGeoJSON(res.origins);\n  }\n\n  if (res.destinations && res.destinations.spatialReference.wkid === 4326) {\n    res.destinations.geoJson = arcgisToGeoJSON(res.destinations);\n  }\n\n  if (res.barriers && res.barriers.spatialReference.wkid === 4326) {\n    res.barriers.geoJson = arcgisToGeoJSON(res.barriers);\n  }\n\n  if (\n    res.polygonBarriers &&\n    res.polygonBarriers.spatialReference.wkid === 4326\n  ) {\n    res.polygonBarriers.geoJson = arcgisToGeoJSON(res.polygonBarriers);\n  }\n\n  if (\n    res.polylineBarriers &&\n    res.polylineBarriers.spatialReference.wkid === 4326\n  ) {\n    res.polylineBarriers.geoJson = arcgisToGeoJSON(res.polylineBarriers);\n  }\n\n  return res;\n}\n\nexport default {\n  originDestinationMatrix\n};\n"]}
+{"version":3,"file":"originDestinationMatrix.js","sourceRoot":"","sources":["../../src/originDestinationMatrix.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EACL,OAAO,EACP,QAAQ,EACR,kBAAkB,EAKnB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACL,2CAA2C,EAE3C,sBAAsB,EACtB,YAAY,EACb,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAiDtD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,uBAAuB,CACrC,cAA+C;IAE/C,MAAM,QAAQ,GACZ,cAAc,CAAC,QAAQ,IAAI,2CAA2C,CAAC;IAEzE,cAAc,CAAC,MAAM,mBACnB,UAAU,EAAE,4BAA4B,EACxC,aAAa,EAAE,IAAI,EACnB,kBAAkB,EAAE,IAAI,EACxB,cAAc,EAAE,IAAI,EACpB,sBAAsB,EAAE,IAAI,EAC5B,qBAAqB,EAAE,IAAI,IACxB,cAAc,CAAC,MAAM,CACzB,CAAC;IAEF,MAAM,OAAO,GAAG,kBAAkB,CAChC,cAAc,EACd;QACE,YAAY;QACZ,UAAU;QACV,kBAAkB;QAClB,iBAAiB;QACjB,eAAe;QACf,oBAAoB;QACpB,gBAAgB;QAChB,wBAAwB;QACxB,uBAAuB;KACxB,CACF,CAAC;IAEF,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,QAAQ,KAAK,2CAA2C,EACxD;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,iGAAiG,CAClG,CAAC;KACH;IAED,sGAAsG;IACtG,IAAI,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE;QACxC,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;KACjD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,OAAO,GAAG,sBAAsB,CAC7C,cAAc,CAAC,OAAO,CACvB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,IAAI,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE;QAC7C,OAAO,CAAC,MAAM,CAAC,YAAY,GAAG,cAAc,CAAC,YAAY,CAAC;KAC3D;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,YAAY,GAAG,sBAAsB,CAClD,cAAc,CAAC,YAAY,CAC5B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,gEAAgE;IAChE,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,IAAI,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SACnD;aAAM;YACL,2DAA2D;YAC3D,0CAA0C;YAC1C,uFAAuF;YACvF,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,sBAAsB,CAC9C,cAAc,CAAC,QAAQ,CACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACb;KACF;IAED,OAAO,OAAO,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,IAAI,CACrE,UAAU,GAAG;QACX,OAAO,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC,CACF,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CACpB,GAAQ,EACR,OAAwB;IAExB,gFAAgF;IAEhF,gIAAgI;IAChI,IACE,OAAO,CAAC,MAAM,CAAC,UAAU,KAAK,6BAA6B;QAC3D,GAAG,CAAC,OAAO;QACX,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAC1C;QACA,GAAG,CAAC,OAAO,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KACpD;IAED,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC7D,GAAG,CAAC,OAAO,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KACpD;IAED,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QACvE,GAAG,CAAC,YAAY,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;KAC9D;IAED,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QAC/D,GAAG,CAAC,QAAQ,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;KACtD;IAED,IACE,GAAG,CAAC,eAAe;QACnB,GAAG,CAAC,eAAe,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAClD;QACA,GAAG,CAAC,eAAe,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;KACpE;IAED,IACE,GAAG,CAAC,gBAAgB;QACpB,GAAG,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EACnD;QACA,GAAG,CAAC,gBAAgB,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;KACtE;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,eAAe;IACb,uBAAuB;CACxB,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  appendCustomParams,\n  IRequestOptions,\n  ILocation,\n  IPoint,\n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL,\n  IEndpointOptions,\n  normalizeLocationsList,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\nexport interface IOriginDestinationMatrixOptions extends IEndpointOptions {\n  /**\n   *  Specify the starting points from which to travel to the destinations.\n   */\n  origins: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify the ending point locations to travel to from the origins.\n   */\n  destinations: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify the type of output returned by the service. Defaults to \"esriNAODOutputSparseMatrix\".\n   */\n  outputType?:\n    | \"esriNAODOutputSparseMatrix\"\n    | \"esriNAODOutputStraightLines\"\n    | \"esriNAODOutputNoLines\";\n  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  returnOrigins?: boolean;\n  returnDestinations?: boolean;\n  returnBarriers?: boolean;\n  returnPolylineBarriers?: boolean;\n  returnPolygonBarriers?: boolean;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: any;\n}\n\nexport interface IOriginDestinationMatrixResponse {\n  messages: [{ type: number; description: string }];\n  /**\n   *  Only present if outputType is \"esriNAODOutputSparseMatrix\". Full description is available at https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm#ESRI_SECTION2_114F8364507C4B56B780DFAD505270FB.\n   */\n  odCostMatrix?: any;\n  /**\n   *  Only present if outputType is \"esriNAODOutputStraightLines\" or \"esriNAODOutputNoLines\". Includes the geometry for the straight line connecting each origin-destination pair when the outputType is \"esriNAODOutputStraightLines\".\n   */\n  odLines?: IFeatureSetWithGeoJson;\n  origins?: IFeatureSetWithGeoJson;\n  destinations?: IFeatureSetWithGeoJson;\n  barriers?: IFeatureSetWithGeoJson;\n  polylineBarriers?: IFeatureSetWithGeoJson;\n  polygonBarriers?: IFeatureSetWithGeoJson;\n}\n\n/**\n * Used to create an origin-destination (OD) cost matrix from multiple origins to multiple destinations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm) for more information.\n *\n * ```js\n * import { originDestinationMatrix } from '@esri/arcgis-rest-routing';\n *\n * originDestinationMatrix({\n *   origins: [\n *     [-90.404302, 38.600621],\n *     [-90.364293, 38.620427],\n *   ],\n *   destinations: [\n *     [-90.444716, 38.635501],\n *     [-90.311919, 38.633523],\n *     [-90.451147, 38.581107]\n *   ],\n *   authentication\n * })\n *   .then(response) // => { ... }\n * ```\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with travel time and/or distance for each origin-destination pair. It returns either odLines or odCostMatrix for this information depending on the outputType you specify.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/origin-destination-cost-matrix-synchronous-service.htm\n */\nexport function originDestinationMatrix(\n  requestOptions: IOriginDestinationMatrixOptions\n): Promise<IOriginDestinationMatrixResponse> {\n  const endpoint =\n    requestOptions.endpoint || ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL;\n\n  requestOptions.params = {\n    outputType: \"esriNAODOutputSparseMatrix\",\n    returnOrigins: true,\n    returnDestinations: true,\n    returnBarriers: true,\n    returnPolylineBarriers: true,\n    returnPolygonBarriers: true,\n    ...requestOptions.params\n  };\n\n  const options = appendCustomParams<IOriginDestinationMatrixOptions>(\n    requestOptions,\n    [\n      \"outputType\",\n      \"barriers\",\n      \"polylineBarriers\",\n      \"polygonBarriers\",\n      \"returnOrigins\",\n      \"returnDestinations\",\n      \"returnBarriers\",\n      \"returnPolylineBarriers\",\n      \"returnPolygonBarriers\"\n    ]\n  );\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    endpoint === ARCGIS_ONLINE_ORIGIN_DESTINATION_MATRIX_URL\n  ) {\n    return Promise.reject(\n      \"Calculating the origin-destination cost matrix using the ArcGIS service requires authentication\"\n    );\n  }\n\n  // use a formatting helper for input params of this type: Array<IPoint | ILocation | [number, number]>\n  if (isFeatureSet(requestOptions.origins)) {\n    options.params.origins = requestOptions.origins;\n  } else {\n    options.params.origins = normalizeLocationsList(\n      requestOptions.origins\n    ).join(\";\");\n  }\n\n  if (isFeatureSet(requestOptions.destinations)) {\n    options.params.destinations = requestOptions.destinations;\n  } else {\n    options.params.destinations = normalizeLocationsList(\n      requestOptions.destinations\n    ).join(\";\");\n  }\n\n  // optional input param that may need point geometry normalizing\n  if (requestOptions.barriers) {\n    if (isFeatureSet(requestOptions.barriers)) {\n      options.params.barriers = requestOptions.barriers;\n    } else {\n      // optional point geometry barriers must be normalized, too\n      // but not if provided as IFeatureSet type\n      // note that optional polylineBarriers and polygonBarriers do not need to be normalized\n      options.params.barriers = normalizeLocationsList(\n        requestOptions.barriers\n      ).join(\";\");\n    }\n  }\n\n  return request(`${cleanUrl(endpoint)}/solveODCostMatrix`, options).then(\n    function (res) {\n      return cleanResponse(res, options);\n    }\n  );\n}\n\nfunction cleanResponse(\n  res: any,\n  options: IRequestOptions\n): IOriginDestinationMatrixResponse {\n  // add \"geoJson\" property to each response property that is an arcgis featureSet\n\n  // res.odLines only exists and only includes geometry in this condition (out of 3 possible options.params.outputType conditions)\n  if (\n    options.params.outputType === \"esriNAODOutputStraightLines\" &&\n    res.odLines &&\n    res.odLines.spatialReference.wkid === 4326\n  ) {\n    res.odLines.geoJson = arcgisToGeoJSON(res.odLines);\n  }\n\n  if (res.origins && res.origins.spatialReference.wkid === 4326) {\n    res.origins.geoJson = arcgisToGeoJSON(res.origins);\n  }\n\n  if (res.destinations && res.destinations.spatialReference.wkid === 4326) {\n    res.destinations.geoJson = arcgisToGeoJSON(res.destinations);\n  }\n\n  if (res.barriers && res.barriers.spatialReference.wkid === 4326) {\n    res.barriers.geoJson = arcgisToGeoJSON(res.barriers);\n  }\n\n  if (\n    res.polygonBarriers &&\n    res.polygonBarriers.spatialReference.wkid === 4326\n  ) {\n    res.polygonBarriers.geoJson = arcgisToGeoJSON(res.polygonBarriers);\n  }\n\n  if (\n    res.polylineBarriers &&\n    res.polylineBarriers.spatialReference.wkid === 4326\n  ) {\n    res.polylineBarriers.geoJson = arcgisToGeoJSON(res.polylineBarriers);\n  }\n\n  return res;\n}\n\nexport default {\n  originDestinationMatrix\n};\n"]}

package/dist/esm/serviceArea.d.ts

@@ -32,9 +32,11 @@ export interface IServiceAreaResponse {
     polylineBarriers?: IFeatureSet;
 }
 /**
+ * Used to find the area that can be reached from the input location within a given travel time or travel distance. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm) for more information.
+ *
  * ```js
  * import { serviceArea } from '@esri/arcgis-rest-routing';
- * //
+ *
  * serviceArea({
  *   facilities: [
  *     [-90.444716, 38.635501],
@@ -45,7 +47,6 @@ export interface IServiceAreaResponse {
  * })
  *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}
  * ```
- * Used to find the area that can be reached from the input location within a given travel time or travel distance. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm) for more information.
  *
  * @param requestOptions Options to pass through to the routing service.
  * @returns A Promise that will resolve with service area polygons for the request.

package/dist/esm/serviceArea.js

@@ -12,9 +12,11 @@ function getTravelDirection(key) {
     }
 }
 /**
+ * Used to find the area that can be reached from the input location within a given travel time or travel distance. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm) for more information.
+ *
  * ```js
  * import { serviceArea } from '@esri/arcgis-rest-routing';
- * //
+ *
  * serviceArea({
  *   facilities: [
  *     [-90.444716, 38.635501],
@@ -25,7 +27,6 @@ function getTravelDirection(key) {
  * })
  *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}
  * ```
- * Used to find the area that can be reached from the input location within a given travel time or travel distance. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm) for more information.
  *
  * @param requestOptions Options to pass through to the routing service.
  * @returns A Promise that will resolve with service area polygons for the request.

package/dist/esm/serviceArea.js.map

@@ -1 +1 @@
-{"version":3,"file":"serviceArea.js","sourceRoot":"","sources":["../../src/serviceArea.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EACL,OAAO,EACP,QAAQ,EACR,kBAAkB,EAInB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACL,8BAA8B,EAE9B,sBAAsB,EACtB,YAAY,EACb,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAoCtD,SAAS,kBAAkB,CACzB,GAAsD;IAEtD,IAAI,GAAG,KAAK,uBAAuB,EAAE;QACnC,OAAO,mCAAmC,CAAC;KAC5C;SAAM;QACL,OAAO,iCAAiC,CAAC;KAC1C;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,WAAW,CACzB,cAAmC;IAEnC,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,IAAI,8BAA8B,CAAC;IAE3E,cAAc,CAAC,MAAM,mBACnB,gBAAgB,EAAE,IAAI,EACtB,cAAc,EAAE,IAAI,EACpB,sBAAsB,EAAE,IAAI,EAC5B,qBAAqB,EAAE,IAAI,EAC3B,gBAAgB,EAAE,IAAI,IACnB,cAAc,CAAC,MAAM,CACzB,CAAC;IAEF,MAAM,OAAO,GAAG,kBAAkB,CAAsB,cAAc,EAAE;QACtE,UAAU;QACV,kBAAkB;QAClB,iBAAiB;QACjB,aAAa;QACb,kBAAkB;QAClB,gBAAgB;QAChB,wBAAwB;QACxB,uBAAuB;QACvB,kBAAkB;KACnB,CAAC,CAAC;IAEH,sBAAsB;IACtB,IAAI,cAAc,CAAC,eAAe,EAAE;QAClC,OAAO,CAAC,MAAM,CAAC,eAAe,GAAG,kBAAkB,CACjD,cAAc,CAAC,eAAe,CAC/B,CAAC;KACH;IAED,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,QAAQ,KAAK,8BAA8B,EAC3C;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,wEAAwE,CACzE,CAAC;KACH;IAED,IAAI,YAAY,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QAC3C,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC;KACvD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,sBAAsB,CAChD,cAAc,CAAC,UAAU,CAC1B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,gEAAgE;IAChE,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,IAAI,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SACnD;aAAM;YACL,2DAA2D;YAC3D,0CAA0C;YAC1C,uFAAuF;YACvF,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,sBAAsB,CAC9C,cAAc,CAAC,QAAQ,CACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACb;KACF;IAED,OAAO,OAAO,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,IAAI,CACpE,aAAa,CACd,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,GAAQ;IAC7B,yDAAyD;IACzD,OAAO,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC;IAEnC,yCAAyC;IACzC,IAAI,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QACjD,GAAG,CAAC,UAAU,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;KAC1D;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,eAAe;IACb,WAAW;CACZ,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  appendCustomParams,\n  ILocation, \n  IPoint, \n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_SERVICE_AREA_URL,\n  IEndpointOptions,\n  normalizeLocationsList,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\nexport interface IServiceAreaOptions extends IEndpointOptions {\n  /**\n   *  Specify one or more locations around which service areas are generated.\n   */\n  facilities: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify if the service should return routes.\n   */\n  travelDirection?: \"incidentsToFacilities\" | \"facilitiesToIncidents\";\n  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  outputLines?: boolean;\n  returnFacilities?: boolean;\n  returnBarriers?: boolean;\n  returnPolylineBarriers?: boolean;\n  returnPolygonBarriers?: boolean;\n  preserveObjectID?: boolean;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: any;\n}\n\nexport interface IServiceAreaResponse {\n  messages: string[];\n  saPolygons?: IFeatureSetWithGeoJson;\n  incidents?: IFeatureSet;\n  facilities?: IFeatureSet;\n  barriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n}\n\nfunction getTravelDirection(\n  key: \"incidentsToFacilities\" | \"facilitiesToIncidents\"\n): \"esriNATravelDirectionFromFacility\" | \"esriNATravelDirectionToFacility\" {\n  if (key === \"incidentsToFacilities\") {\n    return \"esriNATravelDirectionFromFacility\";\n  } else {\n    return \"esriNATravelDirectionToFacility\";\n  }\n}\n\n/**\n * ```js\n * import { serviceArea } from '@esri/arcgis-rest-routing';\n * //\n * serviceArea({\n *   facilities: [\n *     [-90.444716, 38.635501],\n *     [-90.311919, 38.633523],\n *     [-90.451147, 38.581107]\n *    ],\n *    authentication\n * })\n *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}\n * ```\n * Used to find the area that can be reached from the input location within a given travel time or travel distance. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm) for more information.\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with service area polygons for the request.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm\n */\nexport function serviceArea(\n  requestOptions: IServiceAreaOptions\n): Promise<IServiceAreaResponse> {\n  const endpoint = requestOptions.endpoint || ARCGIS_ONLINE_SERVICE_AREA_URL;\n\n  requestOptions.params = {\n    returnFacilities: true,\n    returnBarriers: true,\n    returnPolylineBarriers: true,\n    returnPolygonBarriers: true,\n    preserveObjectID: true,\n    ...requestOptions.params\n  };\n\n  const options = appendCustomParams<IServiceAreaOptions>(requestOptions, [\n    \"barriers\",\n    \"polylineBarriers\",\n    \"polygonBarriers\",\n    \"outputLines\",\n    \"returnFacilities\",\n    \"returnBarriers\",\n    \"returnPolylineBarriers\",\n    \"returnPolygonBarriers\",\n    \"preserveObjectID\"\n  ]);\n\n  // Set travelDirection\n  if (requestOptions.travelDirection) {\n    options.params.travelDirection = getTravelDirection(\n      requestOptions.travelDirection\n    );\n  }\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    endpoint === ARCGIS_ONLINE_SERVICE_AREA_URL\n  ) {\n    return Promise.reject(\n      \"Finding service areas using the ArcGIS service requires authentication\"\n    );\n  }\n\n  if (isFeatureSet(requestOptions.facilities)) {\n    options.params.facilities = requestOptions.facilities;\n  } else {\n    options.params.facilities = normalizeLocationsList(\n      requestOptions.facilities\n    ).join(\";\");\n  }\n\n  // optional input param that may need point geometry normalizing\n  if (requestOptions.barriers) {\n    if (isFeatureSet(requestOptions.barriers)) {\n      options.params.barriers = requestOptions.barriers;\n    } else {\n      // optional point geometry barriers must be normalized, too\n      // but not if provided as IFeatureSet type\n      // note that optional polylineBarriers and polygonBarriers do not need to be normalized\n      options.params.barriers = normalizeLocationsList(\n        requestOptions.barriers\n      ).join(\";\");\n    }\n  }\n\n  return request(`${cleanUrl(endpoint)}/solveServiceArea`, options).then(\n    cleanResponse\n  );\n}\n\nfunction cleanResponse(res: any): IServiceAreaResponse {\n  // remove \"fieldAliases\" because it does not do anything.\n  delete res.saPolygons.fieldAliases;\n\n  // add \"geoJson\" property to \"saPolygons\"\n  if (res.saPolygons.spatialReference.wkid === 4326) {\n    res.saPolygons.geoJson = arcgisToGeoJSON(res.saPolygons);\n  }\n  return res;\n}\n\nexport default {\n  serviceArea\n};\n"]}
+{"version":3,"file":"serviceArea.js","sourceRoot":"","sources":["../../src/serviceArea.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EACL,OAAO,EACP,QAAQ,EACR,kBAAkB,EAInB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACL,8BAA8B,EAE9B,sBAAsB,EACtB,YAAY,EACb,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAoCtD,SAAS,kBAAkB,CACzB,GAAsD;IAEtD,IAAI,GAAG,KAAK,uBAAuB,EAAE;QACnC,OAAO,mCAAmC,CAAC;KAC5C;SAAM;QACL,OAAO,iCAAiC,CAAC;KAC1C;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,WAAW,CACzB,cAAmC;IAEnC,MAAM,QAAQ,GAAG,cAAc,CAAC,QAAQ,IAAI,8BAA8B,CAAC;IAE3E,cAAc,CAAC,MAAM,mBACnB,gBAAgB,EAAE,IAAI,EACtB,cAAc,EAAE,IAAI,EACpB,sBAAsB,EAAE,IAAI,EAC5B,qBAAqB,EAAE,IAAI,EAC3B,gBAAgB,EAAE,IAAI,IACnB,cAAc,CAAC,MAAM,CACzB,CAAC;IAEF,MAAM,OAAO,GAAG,kBAAkB,CAAsB,cAAc,EAAE;QACtE,UAAU;QACV,kBAAkB;QAClB,iBAAiB;QACjB,aAAa;QACb,kBAAkB;QAClB,gBAAgB;QAChB,wBAAwB;QACxB,uBAAuB;QACvB,kBAAkB;KACnB,CAAC,CAAC;IAEH,sBAAsB;IACtB,IAAI,cAAc,CAAC,eAAe,EAAE;QAClC,OAAO,CAAC,MAAM,CAAC,eAAe,GAAG,kBAAkB,CACjD,cAAc,CAAC,eAAe,CAC/B,CAAC;KACH;IAED,uDAAuD;IACvD,IACE,CAAC,cAAc,CAAC,cAAc;QAC9B,QAAQ,KAAK,8BAA8B,EAC3C;QACA,OAAO,OAAO,CAAC,MAAM,CACnB,wEAAwE,CACzE,CAAC;KACH;IAED,IAAI,YAAY,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;QAC3C,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC;KACvD;SAAM;QACL,OAAO,CAAC,MAAM,CAAC,UAAU,GAAG,sBAAsB,CAChD,cAAc,CAAC,UAAU,CAC1B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KACb;IAED,gEAAgE;IAChE,IAAI,cAAc,CAAC,QAAQ,EAAE;QAC3B,IAAI,YAAY,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;SACnD;aAAM;YACL,2DAA2D;YAC3D,0CAA0C;YAC1C,uFAAuF;YACvF,OAAO,CAAC,MAAM,CAAC,QAAQ,GAAG,sBAAsB,CAC9C,cAAc,CAAC,QAAQ,CACxB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACb;KACF;IAED,OAAO,OAAO,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC,IAAI,CACpE,aAAa,CACd,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,GAAQ;IAC7B,yDAAyD;IACzD,OAAO,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC;IAEnC,yCAAyC;IACzC,IAAI,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,KAAK,IAAI,EAAE;QACjD,GAAG,CAAC,UAAU,CAAC,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;KAC1D;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,eAAe;IACb,WAAW;CACZ,CAAC","sourcesContent":["/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.\n * Apache-2.0 */\n\nimport {\n  request,\n  cleanUrl,\n  appendCustomParams,\n  ILocation,\n  IPoint,\n  IFeatureSet\n} from \"@esri/arcgis-rest-request\";\n\nimport {\n  ARCGIS_ONLINE_SERVICE_AREA_URL,\n  IEndpointOptions,\n  normalizeLocationsList,\n  isFeatureSet\n} from \"./helpers.js\";\n\nimport { arcgisToGeoJSON } from \"@terraformer/arcgis\";\n\nexport interface IServiceAreaOptions extends IEndpointOptions {\n  /**\n   *  Specify one or more locations around which service areas are generated.\n   */\n  facilities: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  /**\n   *  Specify if the service should return routes.\n   */\n  travelDirection?: \"incidentsToFacilities\" | \"facilitiesToIncidents\";\n  barriers?: Array<IPoint | ILocation | [number, number]> | IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  outputLines?: boolean;\n  returnFacilities?: boolean;\n  returnBarriers?: boolean;\n  returnPolylineBarriers?: boolean;\n  returnPolygonBarriers?: boolean;\n  preserveObjectID?: boolean;\n}\n\ninterface IFeatureSetWithGeoJson extends IFeatureSet {\n  geoJson?: any;\n}\n\nexport interface IServiceAreaResponse {\n  messages: string[];\n  saPolygons?: IFeatureSetWithGeoJson;\n  incidents?: IFeatureSet;\n  facilities?: IFeatureSet;\n  barriers?: IFeatureSet;\n  polygonBarriers?: IFeatureSet;\n  polylineBarriers?: IFeatureSet;\n}\n\nfunction getTravelDirection(\n  key: \"incidentsToFacilities\" | \"facilitiesToIncidents\"\n): \"esriNATravelDirectionFromFacility\" | \"esriNATravelDirectionToFacility\" {\n  if (key === \"incidentsToFacilities\") {\n    return \"esriNATravelDirectionFromFacility\";\n  } else {\n    return \"esriNATravelDirectionToFacility\";\n  }\n}\n\n/**\n * Used to find the area that can be reached from the input location within a given travel time or travel distance. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm) for more information.\n *\n * ```js\n * import { serviceArea } from '@esri/arcgis-rest-routing';\n *\n * serviceArea({\n *   facilities: [\n *     [-90.444716, 38.635501],\n *     [-90.311919, 38.633523],\n *     [-90.451147, 38.581107]\n *    ],\n *    authentication\n * })\n *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}\n * ```\n *\n * @param requestOptions Options to pass through to the routing service.\n * @returns A Promise that will resolve with service area polygons for the request.\n * @restlink https://developers.arcgis.com/rest/network/api-reference/service-area-synchronous-service.htm\n */\nexport function serviceArea(\n  requestOptions: IServiceAreaOptions\n): Promise<IServiceAreaResponse> {\n  const endpoint = requestOptions.endpoint || ARCGIS_ONLINE_SERVICE_AREA_URL;\n\n  requestOptions.params = {\n    returnFacilities: true,\n    returnBarriers: true,\n    returnPolylineBarriers: true,\n    returnPolygonBarriers: true,\n    preserveObjectID: true,\n    ...requestOptions.params\n  };\n\n  const options = appendCustomParams<IServiceAreaOptions>(requestOptions, [\n    \"barriers\",\n    \"polylineBarriers\",\n    \"polygonBarriers\",\n    \"outputLines\",\n    \"returnFacilities\",\n    \"returnBarriers\",\n    \"returnPolylineBarriers\",\n    \"returnPolygonBarriers\",\n    \"preserveObjectID\"\n  ]);\n\n  // Set travelDirection\n  if (requestOptions.travelDirection) {\n    options.params.travelDirection = getTravelDirection(\n      requestOptions.travelDirection\n    );\n  }\n\n  // the SAAS service does not support anonymous requests\n  if (\n    !requestOptions.authentication &&\n    endpoint === ARCGIS_ONLINE_SERVICE_AREA_URL\n  ) {\n    return Promise.reject(\n      \"Finding service areas using the ArcGIS service requires authentication\"\n    );\n  }\n\n  if (isFeatureSet(requestOptions.facilities)) {\n    options.params.facilities = requestOptions.facilities;\n  } else {\n    options.params.facilities = normalizeLocationsList(\n      requestOptions.facilities\n    ).join(\";\");\n  }\n\n  // optional input param that may need point geometry normalizing\n  if (requestOptions.barriers) {\n    if (isFeatureSet(requestOptions.barriers)) {\n      options.params.barriers = requestOptions.barriers;\n    } else {\n      // optional point geometry barriers must be normalized, too\n      // but not if provided as IFeatureSet type\n      // note that optional polylineBarriers and polygonBarriers do not need to be normalized\n      options.params.barriers = normalizeLocationsList(\n        requestOptions.barriers\n      ).join(\";\");\n    }\n  }\n\n  return request(`${cleanUrl(endpoint)}/solveServiceArea`, options).then(\n    cleanResponse\n  );\n}\n\nfunction cleanResponse(res: any): IServiceAreaResponse {\n  // remove \"fieldAliases\" because it does not do anything.\n  delete res.saPolygons.fieldAliases;\n\n  // add \"geoJson\" property to \"saPolygons\"\n  if (res.saPolygons.spatialReference.wkid === 4326) {\n    res.saPolygons.geoJson = arcgisToGeoJSON(res.saPolygons);\n  }\n  return res;\n}\n\nexport default {\n  serviceArea\n};\n"]}

package/dist/esm/solveRoute.d.ts

@@ -21,9 +21,11 @@ export interface ISolveRouteResponse {
     }>;
 }
 /**
+ * Used to find the best way to get from one location to another or to visit several locations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/route-synchronous-service.htm) for more information.
+ *
  * ```js
  * import { solveRoute } from '@esri/arcgis-rest-routing';
- * //
+ *
  * solveRoute({
  *   stops: [
  *     [-117.195677, 34.056383],
@@ -33,7 +35,6 @@ export interface ISolveRouteResponse {
  * })
  *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}
  * ```
- * Used to find the best way to get from one location to another or to visit several locations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/route-synchronous-service.htm) for more information.
  *
  * @param requestOptions Options to pass through to the routing service.
  * @returns A Promise that will resolve with routes and directions for the request.

package/dist/esm/solveRoute.js

@@ -12,9 +12,11 @@ function isLocation(coords) {
         coords.lat !== undefined);
 }
 /**
+ * Used to find the best way to get from one location to another or to visit several locations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/route-synchronous-service.htm) for more information.
+ *
  * ```js
  * import { solveRoute } from '@esri/arcgis-rest-routing';
- * //
+ *
  * solveRoute({
  *   stops: [
  *     [-117.195677, 34.056383],
@@ -24,7 +26,6 @@ function isLocation(coords) {
  * })
  *   .then(response) // => {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}
  * ```
- * Used to find the best way to get from one location to another or to visit several locations. See the [REST Documentation](https://developers.arcgis.com/rest/network/api-reference/route-synchronous-service.htm) for more information.
  *
  * @param requestOptions Options to pass through to the routing service.
  * @returns A Promise that will resolve with routes and directions for the request.