culparepellendus 1.0.0

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

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

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

@@ -0,0 +1,75 @@
+[![npm version][npm-img]][npm-url]
+[![build status][travis-img]][travis-url]
+[![gzip bundle size][gzip-image]][npm-url]
+[![Coverage Status][coverage-img]][coverage-url]
+[![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/arcgis-rest-js/master/LICENSE)
+
+[npm-img]: https://img.shields.io/npm/v/@esri/arcgis-rest-demographics.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-demographics
+[travis-img]: https://img.shields.io/travis/Esri/arcgis-rest-js/master.svg?style=flat-square
+[travis-url]: https://travis-ci.org/Esri/arcgis-rest-js
+[gzip-image]: https://img.badgesize.io/https://unpkg.com/@esri/arcgis-rest-demographics/dist/umd/demographics.umd.min.js?compression=gzip
+[coverage-img]: https://codecov.io/gh/Esri/arcgis-rest-js/branch/master/graph/badge.svg
+[coverage-url]: https://codecov.io/gh/Esri/arcgis-rest-js
+
+# @esri/arcgis-rest-demographics
+
+> Demographics helpers for [`@esri/arcgis-rest-request`](https://github.com/Esri/arcgis-rest-js).
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+npm install @esri/arcgis-rest-demographics
+```
+
+```js
+import { getAvailableDataCollections } from '@esri/arcgis-rest-demographics';
+
+getAvailableDataCollections()
+  .then((response) => {
+    response.DataCollections;
+    // => [{ dataCollectionId: "KeyGlobalFacts", metadata: { ... }, data: [ ... ] }, ... ]
+  });
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/demographics/)
+
+* [`getAvailableDataCollections({countryCode: 'us'})`](https://esri.github.io/arcgis-rest-js/api/demographics/getAvailableDataCollections/)
+* [`queryDemographicData({studyAreas: [{"geometry":{"x":-117.1956,"y":34.0572}}], authentication})`](https://esri.github.io/arcgis-rest-js/api/demographics/queryDemographicData/)
+
+### Issues
+
+If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first.  Have you found a new bug?  Want to request a new feature?  We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you.
+
+If you're looking for help you can also post issues on [GIS Stackexchange](http://gis.stackexchange.com/questions/ask?tags=esri-oss).
+
+### Versioning
+
+For transparency into the release cycle and in striving to maintain backward compatibility, @esri/arcgis-rest-js is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible.
+
+For more information on SemVer, please visit <http://semver.org/>.
+
+### Contributing
+
+Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](CONTRIBUTING.md).
+
+### [Changelog](https://github.com/Esri/arcgis-rest-js/blob/master/CHANGELOG.md)
+
+### License
+
+Copyright &copy; 2017-2019 Esri
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+> http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+A copy of the license is available in the repository's [LICENSE](../../LICENSE) file.

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

@@ -0,0 +1,11 @@
+{
+	"requires": true,
+	"lockfileVersion": 1,
+	"dependencies": {
+		"tslib": {
+			"version": "2.3.1",
+			"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz",
+			"integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw=="
+		}
+	}
+}

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

@@ -0,0 +1,69 @@
+{
+  "name": "@esri/arcgis-rest-demographics",
+  "version": "3.4.3",
+  "description": "Demographics data helpers for @esri/arcgis-rest-js",
+  "main": "dist/node/index.js",
+  "unpkg": "dist/umd/geocoding.umd.js",
+  "module": "dist/esm/index.js",
+  "js:next": "dist/esm/index.js",
+  "sideEffects": false,
+  "types": "dist/esm/index.d.ts",
+  "license": "Apache-2.0",
+  "files": [
+    "dist/**"
+  ],
+  "dependencies": {
+    "@esri/arcgis-rest-types": "^3.4.3",
+    "tslib": "^1.13.0"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-auth": "^3.4.3",
+    "@esri/arcgis-rest-request": "^3.4.3"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-auth": "^3.0.0",
+    "@esri/arcgis-rest-request": "^3.0.0"
+  },
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "npm run build:node && npm run build:umd && npm run build:esm",
+    "build:esm": "tsc --module es2015 --outDir ./dist/esm --declaration",
+    "build:umd": "rollup -c ../../umd-base-profile.js && rollup -c ../../umd-production-profile.js",
+    "build:node": "tsc --module commonjs --outDir ./dist/node",
+    "dev:esm": "tsc -w --module es2015 --outDir ./dist/esm --declaration",
+    "dev:umd": "rollup -w -c ../../umd-base-profile.js",
+    "dev:node": "tsc -w --module commonjs --outDir ./dist/node"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Esri/arcgis-rest-js.git",
+    "directory": "packages/arcgis-rest-demographics"
+  },
+  "contributors": [
+    {
+      "name": "Patrick Arlt",
+      "email": "parlt@esri.com",
+      "url": "http://patrickarlt.com/"
+    },
+    {
+      "name": "Gavin Rehkemper",
+      "email": "grehkemper@esri.com",
+      "url": "http://gavinr.com/"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "homepage": "https://github.com/Esri/arcgis-rest-js#readme",
+  "keywords": [
+    "typescript",
+    "promise",
+    "fetch",
+    "arcgis",
+    "esri",
+    "ES6"
+  ]
+}

package/packages/arcgis-rest-demographics/src/getAvailableCountries.ts

@@ -0,0 +1,113 @@
+/* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+import { IEnvelope } from "@esri/arcgis-rest-types";
+
+import { ARCGIS_ONLINE_GEOENRICHMENT_URL, IEndpointOptions } from "./helpers";
+
+export interface IGetAvailableCountriesOptions extends IEndpointOptions {
+  /**
+   * View a description for a given country. If not specified, will return a list of all countries.
+   */
+  countryCode?: string;
+}
+
+export interface IGetAvailableCountriesResponse {
+  messages?: string[];
+  countries?: ICountry[];
+  childResources?: any[];
+}
+export interface ICountry {
+  id: string;
+  name: string;
+  abbr3: string;
+  altName: string;
+  continent: string;
+  distanceUnits: string;
+  esriUnits: string;
+  defaultExtent: IEnvelope;
+  defaultDatasetID: string;
+  datasets?: string[];
+  hierarchies?: IHierarchy[];
+  defaultDataCollection: string;
+  dataCollections: string;
+  defaultReportTemplate: string;
+  currencySymbol: string;
+  currencyFormat: string;
+}
+export interface IHierarchy {
+  ID: string;
+  alias: string;
+  shortDescription: string;
+  default: boolean;
+  longDescription: string;
+  locales?: string[];
+  datasets?: string[];
+  levelsInfo: ILevelsInfo;
+  variablesInfo: IVariablesInfo;
+  populationToPolygonSizeRating: number;
+  apportionmentConfidence: number;
+  apportionmentThresholds?: IApportionmentThreshold[];
+  hasMarginOfErrorData?: boolean;
+}
+export interface ILevelsInfo {
+  geographyLevels?: string[];
+}
+export interface IVariablesInfo {
+  categories?: string[];
+}
+export interface IApportionmentThreshold {
+  method: string;
+  dataLayer: string;
+  pointsLayer?: string;
+  maximumSize?: number;
+}
+
+
+/**
+ * ```js
+ * import { getAvailableCountries } from '@esri/arcgis-rest-demographics';
+ * //
+ * getAvailableCountries()
+ *   .then((response) => {
+ *     response; // => { countries: [ ... ]  }
+ *   });
+ * ```
+ * Return a list of information for all countries. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/countries.htm) for more information.
+ * @param requestOptions Options to pass through to the geoenrichment service.
+ * @returns A Promise that will resolve with available geography levels for the request.
+ */
+export function getAvailableCountries(
+  requestOptions?: IGetAvailableCountriesOptions
+): Promise<IGetAvailableCountriesResponse> {
+  let options: IEndpointOptions = {};
+  let endpoint = `${ARCGIS_ONLINE_GEOENRICHMENT_URL}/countries`;
+  if (!requestOptions) {
+    options.params = {};
+  } else {
+    if (requestOptions.endpoint) {
+      endpoint = `${requestOptions.endpoint}/countries`;
+    }
+
+    options = appendCustomParams<IGetAvailableCountriesOptions>(
+      requestOptions,
+      [],
+      { params: { ...requestOptions.params } }
+    );
+    if (requestOptions.countryCode) {
+      endpoint = `${endpoint}/${requestOptions.countryCode}`;
+    }
+  }
+
+
+  return request(cleanUrl(endpoint), options).then(
+    (response: any) => {
+      return response;
+    }
+  );
+}

package/packages/arcgis-rest-demographics/src/getAvailableDataCollections.ts

@@ -0,0 +1,166 @@
+/* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+
+import { ARCGIS_ONLINE_GEOENRICHMENT_URL, IEndpointOptions } from "./helpers";
+
+export interface IGetAvailableDataCollectionsOptions extends IEndpointOptions {
+  /**
+   * Optional parameter to specify an array of string values that describe what derivative variables to include in the output.
+   */
+  addDerivativeVariables?: string[];
+  /**
+   * Optional parameter to return only values that are not NULL in the output response.
+   */
+  suppressNullValues?: boolean;
+  /**
+   * View a description for a single data collection within a given country. If not specified, will return a list of data collections that can be run in any country.
+   */
+  countryCode?: string;
+  dataCollection?: string;
+}
+
+
+export interface IGetAvailableDataCollectionsResponse {
+  DataCollections?: (IDataCollection)[] | null;
+}
+export interface IDataCollection {
+  dataCollectionID: string;
+  metadata: IMetadata;
+  data?: (IDataInfo)[] | null;
+}
+export interface IMetadata {
+  title: string;
+  name: string;
+  shortDescription: string;
+  longDescription: string;
+  url: string;
+  keywords: string;
+  creationDate: number;
+  lastRevisionDate: number;
+  webmap: string;
+  author: string;
+  countries?: string | null;
+  IsRoyalties: boolean;
+  categories?: ICategory[] | null;
+  filters?: (IFilter)[] | null;
+  datasets?: string | null;
+  hierarchies: string;
+  coverage?: string | null;
+  mobileinfographics?: string | null;
+  icon?: string | null;
+}
+export interface ICategory {
+  id: string;
+  name: string;
+  alias: string;
+  description: string;
+  displayOrder: string;
+}
+export interface IFilter {
+  id: string;
+  name: string;
+  aliasname: string;
+  type: string;
+  rangeMax?: string | null;
+  rangeMin?: string | null;
+  enumValues?: string | null;
+}
+export interface IDataInfo {
+  id: string;
+  alias: string;
+  type: string;
+  precision: number;
+  length?: null;
+  averageBase?: null;
+  averageBaseAlias?: null;
+  description: string;
+  fieldCategory: string;
+  indexBase?: number | null;
+  percentBase?: string | null;
+  percentBaseAlias?: string | null;
+  popularity?: number | null;
+  units: string;
+  vintage?: string | null;
+  hideInDataBrowser: boolean;
+  filteringTags?: IFilteringTag[] | null;
+  derivative: boolean;
+  provider: string;
+  indexType?: string | null;
+}
+export interface IFilteringTag {
+  id: string;
+  name: string;
+  value: string;
+}
+
+
+/**
+ * ```js
+ * import { getAvailableDataCollections } from '@esri/arcgis-rest-demographics';
+ * //
+ * getAvailableDataCollections()
+ *   .then((response) => {
+ *     response; // => { DataCollections: [ ... ]  }
+ *   });
+ * //
+ * getAvailableDataCollections({
+ *   countryCode: "se",
+ *   dataCollection: "EducationalAttainment"
+ * })
+ *   .then((response) => {
+ *     response.; // => { DataCollections: [ ... ] }
+ *   });
+ * ```
+ * Used to determine the data collections available for usage with the Geoenrichment service. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/data-collections.htm) for more information.
+ * @param requestOptions Options to pass through to the geoenrichment service.
+ * @returns A Promise that will resolve with data collections for the request.
+ */
+export function getAvailableDataCollections(
+  requestOptions?: IGetAvailableDataCollectionsOptions
+): Promise<IGetAvailableDataCollectionsResponse> {
+  let options: IGetAvailableDataCollectionsOptions = {};
+  let endpoint = `${ARCGIS_ONLINE_GEOENRICHMENT_URL}/dataCollections`;
+  
+
+  if (!requestOptions) {
+    options.params = {};
+  } else {
+    if (requestOptions.endpoint) {
+      endpoint = `${requestOptions.endpoint}/dataCollections`;
+    }
+    options = appendCustomParams<IGetAvailableDataCollectionsOptions>(
+      requestOptions,
+      [
+        "addDerivativeVariables",
+        "suppressNullValues",
+      ],
+      { params: { ...requestOptions.params } }
+    );
+
+    if (options.params.addDerivativeVariables) {
+      options.params.addDerivativeVariables = JSON.stringify(options.params.addDerivativeVariables);
+    }
+
+    if(requestOptions.countryCode) {
+      endpoint = `${endpoint}/${requestOptions.countryCode}`;
+      if(requestOptions.dataCollection) {
+        endpoint = `${endpoint}/${requestOptions.dataCollection}`;
+      }
+    }
+  }
+
+  
+
+  // add spatialReference property to individual matches
+  return request(`${cleanUrl(endpoint)}`, options).then(
+    (response: any) => {
+      return response;
+    }
+  );
+}

package/packages/arcgis-rest-demographics/src/getAvailableGeographyLevels.ts

@@ -0,0 +1,88 @@
+/* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+
+import { ARCGIS_ONLINE_GEOENRICHMENT_URL, IEndpointOptions } from "./helpers";
+
+export interface IGetAvailableGeographyLevelsResponse {
+  messages?: string[] | null;
+  childResources?: any[] | null;
+  childDatasets?: any[] | null;
+  childHierarchies?: any[] | null;
+  geographyLevels?: IGeographyLevel[] | null;
+}
+export interface IGeographyLevel {
+  countryID: string;
+  countryName: string;
+  datasets?: IDataset[] | null;
+  hierarchies?: IGeographyLevelHierarchy[] | null;
+}
+export interface IDataset {
+  datasetID: string;
+  branches?: IBranch[] | null;
+  levels?: ILevel[] | null;
+}
+export interface IBranch {
+  id: string;
+  name: string;
+  levels?: string[] | null;
+}
+export interface ILevel {
+  id: string;
+  name: string;
+  isWholeCountry: boolean;
+  adminLevel: string;
+  singularName: string;
+  pluralName: string;
+  description?: string | null;
+}
+export interface IGeographyLevelHierarchy {
+  ID: string;
+  branches?: IBranch[] | null;
+  levels?: ILevel[] | null;
+}
+
+
+/**
+ * ```js
+ * import { getAvailableGeographyLevels } from '@esri/arcgis-rest-demographics';
+ * //
+ * getAvailableGeographyLevels()
+ *   .then((response) => {
+ *     response; // => { geographyLevels: [ ... ]  }
+ *   });
+ * ```
+ * Returns a list of available geography data layers, which can then be used in [getGeography()](). See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-levels.htm) for more information.
+ * @param requestOptions Options to pass through to the geoenrichment service.
+ * @returns A Promise that will resolve with available geography levels for the request.
+ */
+export function getAvailableGeographyLevels(
+  requestOptions?: IEndpointOptions
+): Promise<IGetAvailableGeographyLevelsResponse> {
+  let options: IEndpointOptions = {};
+  let endpoint = `${ARCGIS_ONLINE_GEOENRICHMENT_URL}/StandardGeographyLevels`;
+
+  if (!requestOptions) {
+    options.params = {};
+  } else {
+    if (requestOptions.endpoint) {
+      endpoint = `${requestOptions.endpoint}/StandardGeographyLevels`;
+    }
+    options = appendCustomParams<IEndpointOptions>(
+      requestOptions,
+      [],
+      { params: { ...requestOptions.params } }
+    );
+  }
+
+  return request(`${cleanUrl(endpoint)}`, options).then(
+    (response: any) => {
+      return response;
+    }
+  );
+}

package/packages/arcgis-rest-demographics/src/getGeography.ts

@@ -0,0 +1,152 @@
+/* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+
+import { ARCGIS_ONLINE_STANDARD_GEOGRAPHY_QUERY_URL, IGeoenrichmentResult, IEndpointOptions } from "./helpers";
+
+export interface IGetGeographyOptions extends IEndpointOptions {
+  /**
+   * Specify the source country for the search.
+   */
+  sourceCountry?: string;
+  /**
+   * Specify a specific dataset within a defined country.
+   */
+  optionalCountryDataset?: string;
+  /**
+   * Specify which standard geography layers are being queried or searched.
+   */
+  geographyLayers?: string[] | string;
+  /**
+   * Specify which IDs for the standard geography layers are being queried or searched.
+   */
+  geographyIDs?: string[];
+  /**
+   * Specify the text to query and search the standard geography layers specified.
+   */
+  geographyQuery?: string;
+  /**
+   * Return all the subgeographic areas that are within a parent geography.
+   */
+  returnSubGeographyLayer?: boolean;
+  /**
+   * Return all the subgeographic areas that are within a parent geography.
+   */
+  subGeographyLayer?: string;
+  /**
+   * Filter the results of the subgeography features that are returned by a search term.
+   */
+  subGeographyQuery?: string;
+  /**
+   * Request the output geometries in a specified spatial reference system.
+   */
+  outSR?: number;
+  /**
+   * Request the output geometries in the response.
+   */
+  returnGeometry?: boolean;
+  /**
+   * Request the output geometry to return the center point for each feature.
+   */
+  returnCentroids?: boolean;
+  /**
+   * Integer that specifies the level of generalization or detail in the area representations of the administrative boundary or standard geographic data layers.
+   */
+  generalizationLevel?: number;
+  /**
+   * Define if text provided in the geographyQuery parameter should utilize fuzzy search logic.
+   */
+  useFuzzySearch?: boolean;
+  /**
+   * Limits the number of features that are returned from the geographyQuery parameter.
+   */
+  featureLimit?: number;
+  /**
+   * Starts the results on the number of the records specified.
+   */
+  featureOffset?: number;
+  /**
+   * Specifies the language you wish to receive your GeoEnrichment results.
+   */
+  langCode?: string;
+}
+
+
+export interface IGetGeographyResponse {
+  results: IGeoenrichmentResult[] | null;
+  messages: string[] | null;
+}
+
+/**
+ * ```js
+ * import { getGeography } from '@esri/arcgis-rest-demographics';
+ * //
+ * getGeography({
+ *   sourceCountry: "CA",
+ *   geographyIDs: ["35"]
+ * })
+ *   .then((response) => {
+ *     response.; // => { results: [ ... ] }
+ *   });
+ * ```
+ * Used to get standard geography IDs and features for the supported geographic levels. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-query.htm) and the [best practices post](https://www.esri.com/arcgis-blog/products/arcgis-online/uncategorized/best-practices-how-to-query-standard-geographies-branches) for more information.
+ * @param requestOptions Options to pass through to the service. All properties are optional, but either `geographyIds` or `geographyQuery` must be sent at a minimum.
+ * @returns A Promise that will resolve with return data defined and optionally geometry for the feature.
+ */
+export function getGeography(
+  requestOptions?: IGetGeographyOptions
+): Promise<IGetGeographyResponse> {
+  const endpoint = `${requestOptions.endpoint || ARCGIS_ONLINE_STANDARD_GEOGRAPHY_QUERY_URL}/execute`;
+
+  const options = appendCustomParams<IGetGeographyOptions>(
+    requestOptions,
+    [
+      "sourceCountry",
+      "optionalCountryDataset",
+      "geographyLayers",
+      "geographyIDs",
+      "geographyQuery",
+      "returnSubGeographyLayer",
+      "subGeographyLayer",
+      "subGeographyQuery",
+      "outSR",
+      "returnGeometry",
+      "returnCentroids",
+      "generalizationLevel",
+      "useFuzzySearch",
+      "featureLimit",
+      "featureOffset",
+      "langCode",
+    ],
+    { params: { ...requestOptions.params } }
+  );
+
+  // the SAAS service does not support anonymous requests
+  if (
+    !requestOptions.authentication
+  ) {
+    return Promise.reject(
+      "Geoenrichment using the ArcGIS service requires authentication"
+    );
+  }
+
+  // These parameters are passed as JSON-style strings:
+  ["geographyLayers", "geographyIDs"].forEach((parameter) => {
+    if (options.params[parameter]) {
+      options.params[parameter] = JSON.stringify(options.params[parameter]);
+    }
+  });
+  
+
+  // add spatialReference property to individual matches
+  return request(`${cleanUrl(endpoint)}`, options).then(
+    (response: any) => {
+      return response;
+    }
+  );
+}