sintfacilis 1.0.0

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

@@ -0,0 +1,8 @@
+/* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export * from "./getAvailableCountries";
+export * from "./getAvailableDataCollections";
+export * from "./getAvailableGeographyLevels";
+export * from "./getGeography";
+export * from "./queryDemographicData";

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

@@ -0,0 +1,106 @@
+/* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+import { IFeatureSet } from "@esri/arcgis-rest-types";
+
+import { ARCGIS_ONLINE_GEOENRICHMENT_URL, IGeoenrichmentResult, IEndpointOptions } from "./helpers";
+
+export interface IQueryDemographicDataOptions extends IEndpointOptions {
+  /**
+   * Defines the area on a map which is being analyzed
+   */
+  studyAreas: any[];
+  /**
+   * A Data Collection is a preassembled list of attributes that will be used to enrich the input features. Enrichment attributes can describe various types of information such as demographic characteristics and geographic context of the locations or areas submitted as input features in studyAreas.
+   */
+  dataCollections?: string[];
+  /**
+   * Specify a subset of variables to be returned from one or more Data Collections
+   */
+  analysisVariables?: string[];
+  /**
+   * Specify an array of string values that describe what derivative variables to include in the output
+   */
+  addDerivativeVariables?: boolean;
+  /**
+   * Request the output geometries in the response
+   */
+  returnGeometry?: boolean;
+  /**
+   * Define the input geometries in the studyAreas parameter in a specified spatial reference system
+   */
+  inSR?: number;
+  /**
+   * Request the output geometries in a specified spatial reference system
+   */
+  outSR?: number;
+}
+
+
+export interface IQueryDemographicDataResponse {
+  results: IGeoenrichmentResult[] | null;
+  messages: string[] | null;
+}
+
+/**
+ * ```js
+ * import { queryDemographicData } from '@esri/arcgis-rest-demographics';
+ * //
+ * queryDemographicData({
+ *  studyAreas: [{"geometry":{"x":-117.1956,"y":34.0572}}],
+ *  authentication
+ * })
+ *   .then((response) => {
+ *     response; // => { results: [ ... ] }
+ *   });
+ * ```
+ * Used to get facts about a location or area. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/enrich.htm) for more information.
+ * @param requestOptions Options to pass through to the service.
+ * @returns A Promise that will resolve with results for the request.
+ */
+export function queryDemographicData(
+  requestOptions?: IQueryDemographicDataOptions
+): Promise<IQueryDemographicDataResponse> {
+
+  const options = appendCustomParams<IQueryDemographicDataOptions>(
+    requestOptions,
+    [
+      "studyAreas",
+      "dataCollections",
+      "analysisVariables",
+      "addDerivativeVariables",
+      "returnGeometry",
+      "inSR",
+      "outSR",
+    ],
+    { 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:
+  ["dataCollections", "analysisVariables"].forEach((parameter) => {
+    if (options.params[parameter]) {
+      options.params[parameter] = JSON.stringify(options.params[parameter]);
+    }
+  });
+
+  // add spatialReference property to individual matches
+  return request(`${cleanUrl(`${requestOptions.endpoint || ARCGIS_ONLINE_GEOENRICHMENT_URL}/enrich`)}`, options).then(
+    (response: any) => {
+      return response;
+    }
+  );
+}

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

@@ -0,0 +1,92 @@
+/* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { getAvailableCountries } from "../src/getAvailableCountries";
+
+import * as fetchMock from "fetch-mock";
+
+describe("getAvailableCountries", () => {
+  afterEach(fetchMock.restore);
+
+  it("should make a simple, single getAvailableCountries request", done => {
+    fetchMock.once("*", {});
+
+    getAvailableCountries()
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/countries"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a getAvailableCountries request with a countryCode", done => {
+    fetchMock.once("*", {});
+
+    getAvailableCountries({
+      countryCode: 'us'
+    })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/countries/us"
+        );
+        expect(options.body).not.toContain("countryCode=us");
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a getAvailableCountries request with a param", done => {
+    fetchMock.once("*", {});
+
+    getAvailableCountries({
+      params: {
+        foo: "bar"
+      }
+    })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/countries"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("foo=bar");
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a getAvailableCountries request with a custom endpoint", done => {
+    fetchMock.once("*", {});
+
+    getAvailableCountries({
+      endpoint: 'https://esri.com/test'
+    })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://esri.com/test/countries"
+        );
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

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

@@ -0,0 +1,115 @@
+/* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { getAvailableDataCollections } from "../src/getAvailableDataCollections";
+import {
+  dataCollectionsResponse,
+} from "./mocks/responses";
+
+import * as fetchMock from "fetch-mock";
+
+describe("getAvailableDataCollections", () => {
+  afterEach(fetchMock.restore);
+
+  it("should make a simple, single dataCollections request", done => {
+    fetchMock.once("*", dataCollectionsResponse);
+
+    getAvailableDataCollections()
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/dataCollections"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a dataCollections request with a countryCode", done => {
+    fetchMock.once("*", dataCollectionsResponse);
+
+    getAvailableDataCollections({
+      countryCode: 'us'
+    })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/dataCollections/us"
+        );
+        expect(options.body).not.toContain("countryCode=us");
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a dataCollections request with a countryCode and data collection", done => {
+    fetchMock.once("*", dataCollectionsResponse);
+
+    getAvailableDataCollections({
+      countryCode: 'us',
+      dataCollection: 'EducationalAttainment'
+    })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/dataCollections/us/EducationalAttainment"
+        );
+        expect(options.body).not.toContain("countryCode=us");
+        expect(options.body).not.toContain("dataCollection=EducationalAttainment");
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a dataCollections request with additional parameters", done => {
+    fetchMock.once("*", dataCollectionsResponse);
+
+    getAvailableDataCollections({
+      suppressNullValues: true,
+      addDerivativeVariables: ["average","index"]
+    })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/dataCollections"
+        );
+        expect(options.body).toContain("suppressNullValues=true");
+        expect(options.body).toContain(`addDerivativeVariables=${encodeURIComponent('["average","index"]')}`);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a dataCollections request with a custom endpoint", done => {
+    fetchMock.once("*", dataCollectionsResponse);
+
+    getAvailableDataCollections({
+      endpoint: 'https://esri.com/test'
+    })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://esri.com/test/dataCollections"
+        );
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

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

@@ -0,0 +1,72 @@
+/* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { getAvailableGeographyLevels } from "../src/getAvailableGeographyLevels";
+
+import * as fetchMock from "fetch-mock";
+
+describe("getAvailableGeographyLevels", () => {
+  afterEach(fetchMock.restore);
+
+  it("should make a simple, single dataCollections request", done => {
+    fetchMock.once("*", {});
+
+    getAvailableGeographyLevels()
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/StandardGeographyLevels"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a dataCollections request with a custom endpoint", done => {
+    fetchMock.once("*", {});
+
+    getAvailableGeographyLevels({
+      endpoint: 'https://esri.com/test'
+    })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://esri.com/test/StandardGeographyLevels"
+        );
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a dataCollections request with a param", done => {
+    fetchMock.once("*", {});
+
+    getAvailableGeographyLevels({
+      params: {
+        foo: "bar"
+      }
+    })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/StandardGeographyLevels"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("foo=bar");
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

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

@@ -0,0 +1,141 @@
+/* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { getGeography } from "../src/getGeography";
+
+import * as fetchMock from "fetch-mock";
+
+const MOCK_AUTH = {
+  getToken() {
+    return Promise.resolve("token");
+  },
+  portal: "https://mapsdev.arcgis.com"
+};
+
+describe("getGeography", () => {
+  afterEach(fetchMock.restore);
+
+  it("should throw an error when a getGeography request is made without a token", done => {
+    fetchMock.once("*", {});
+
+    getGeography({
+      geographyIDs: ["35"]
+    })
+      // tslint:disable-next-line
+      .catch(e => {
+        expect(e).toEqual(
+          "Geoenrichment using the ArcGIS service requires authentication"
+        );
+        done();
+      });
+  });
+
+  it("should make a simple, single getGeography request", done => {
+    fetchMock.once("*", {});
+
+    const geographyIDs = ["35"];
+    getGeography({
+      authentication: MOCK_AUTH,
+      geographyIDs
+    })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/StandardGeographyQuery/execute"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("geographyIDs");
+        expect(options.body).toContain(`geographyIDs=${encodeURIComponent(JSON.stringify(geographyIDs))}`);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a getGeography request with a custom endpoint", done => {
+    fetchMock.once("*", {});
+
+    const geographyIDs = ["35"];
+    getGeography({
+      authentication: MOCK_AUTH,
+      geographyIDs,
+      endpoint: 'https://esri.com/test'
+    })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://esri.com/test/execute"
+        );
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("geographyIDs");
+        expect(options.body).toContain(`geographyIDs=${encodeURIComponent(JSON.stringify(geographyIDs))}`);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should make a getGeography request with additional parameters", done => {
+    fetchMock.once("*", {});
+
+    // const studyAreas = [{"sourceCountry":"US","layer":"US.States","ids":["06"],"generalizationLevel":"6"}];
+    // const dataCollections = ["KeyGlobalFacts"];
+    // const analysisVariables = ["KeyGlobalFacts.TOTPOP"];
+    const geographyLayers = ["CAN.PR"];
+    const geographyIDs = ["92129", "92126"];
+    getGeography({
+      authentication: MOCK_AUTH,
+      sourceCountry: 'US',
+      optionalCountryDataset: 'JPN_EsriJapan_2018',
+      geographyLayers,
+      geographyIDs,
+      geographyQuery: 'orange',
+      returnSubGeographyLayer: true,
+      subGeographyLayer: 'CAN.FSA',
+      subGeographyQuery: '921*',
+      outSR: 3857,
+      returnGeometry: true,
+      returnCentroids: true,
+      generalizationLevel: 2,
+      useFuzzySearch: true,
+      featureLimit: 50,
+      featureOffset: 100,
+      langCode: 'en',
+    })
+      .then(response => {
+        expect(fetchMock.called()).toEqual(true);
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          "https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/StandardGeographyQuery/execute"
+        );
+        
+        expect(options.body).toContain(`sourceCountry=US`);
+        expect(options.body).toContain(`optionalCountryDataset=JPN_EsriJapan_2018`);
+        expect(options.body).toContain(`geographyLayers=${encodeURIComponent(JSON.stringify(geographyLayers))}`);
+        expect(options.body).toContain(`geographyIDs=${encodeURIComponent(JSON.stringify(geographyIDs))}`);
+        expect(options.body).toContain(`geographyQuery=orange`);
+        expect(options.body).toContain(`returnSubGeographyLayer=true`);
+        expect(options.body).toContain(`subGeographyLayer=CAN.FSA`);
+        expect(options.body).toContain(`subGeographyQuery=921*`);
+        expect(options.body).toContain(`outSR=3857`);
+        expect(options.body).toContain(`returnGeometry=true`);
+        expect(options.body).toContain(`returnCentroids=true`);
+        expect(options.body).toContain(`generalizationLevel=2`);
+        expect(options.body).toContain(`useFuzzySearch=true`);
+        expect(options.body).toContain(`featureLimit=50`);
+        expect(options.body).toContain(`featureOffset=100`);
+        expect(options.body).toContain(`langCode=en`);
+
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

package/packages/arcgis-rest-demographics/test/mocks/responses.ts

@@ -0,0 +1,4 @@
+/* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export const dataCollectionsResponse: any = {"DataCollections":[{"dataCollectionID":"KeyGlobalFacts","metadata":{"title":"Key Global Facts","name":"KeyGlobalFacts","shortDescription":"Key global demographic facts","longDescription":"Key demographic facts for the all countries supported by the geoenrichment service, variables include population, households, gender, and average household size.  The source for the data from the U.S. is Esri, Environics for Canada, and Michael Bauer Research (BMBR) for the remaining countries.","url":"","keywords":"Global, Key, Facts, Demographics, Indicators, Population","creationDate":0,"lastRevisionDate":0,"webmap":"","coverage":"North America, Europe, and the rest of the world","author":"Esri","countries":null,"IsRoyalties":false,"mobileinfographics":"{\"icon\":true}","icon":"key","categories":[{"id":"Population","name":"Population","alias":"Population","description":"Population Category","displayOrder":"100"}],"filters":[{"id":"Gender","name":"Gender","aliasname":"Gender","type":"Enumeration","enumValues":"Male,Female"}],"datasets":null,"hierarchies":"census"},"data":[{"id":"TOTPOP","alias":"Total Population","type":"esriFieldTypeDouble","precision":0,"length":null,"averageBase":null,"averageBaseAlias":null,"description":null,"fieldCategory":"Key Demographic Indicators","indexBase":null,"percentBase":null,"percentBaseAlias":null,"popularity":20,"units":"count","vintage":null,"hideInDataBrowser":true,"filteringTags":[],"derivative":false,"provider":"MBR"},{"id":"TOTHH","alias":"Total Households","type":"esriFieldTypeDouble","precision":0,"length":null,"averageBase":null,"averageBaseAlias":null,"description":null,"fieldCategory":"Key Demographic Indicators","indexBase":null,"percentBase":null,"percentBaseAlias":null,"popularity":null,"units":"count","vintage":null,"hideInDataBrowser":true,"filteringTags":[],"derivative":false,"provider":"MBR"},{"id":"AVGHHSZ","alias":"Average Household Size","type":"esriFieldTypeDouble","precision":2,"length":null,"averageBase":null,"averageBaseAlias":null,"description":null,"fieldCategory":"Key Demographic Indicators","indexBase":2.58,"percentBase":null,"percentBaseAlias":null,"popularity":10,"units":"count","vintage":null,"hideInDataBrowser":true,"filteringTags":[],"derivative":false,"provider":"MBR"},{"id":"TOTMALES","alias":"Male Population","type":"esriFieldTypeDouble","precision":0,"length":null,"averageBase":null,"averageBaseAlias":null,"description":null,"fieldCategory":"Age: 5 Year Increments","indexBase":null,"percentBase":"TOTPOP_CY","percentBaseAlias":null,"popularity":null,"units":"count","vintage":null,"hideInDataBrowser":true,"filteringTags":[{"id":"Gender","name":"Gender","value":"Male"}],"derivative":false,"provider":"MBR"},{"id":"TOTFEMALES","alias":"Female Population","type":"esriFieldTypeDouble","precision":0,"length":null,"averageBase":null,"averageBaseAlias":null,"description":null,"fieldCategory":"Age: 5 Year Increments","indexBase":null,"percentBase":"TOTPOP_CY","percentBaseAlias":null,"popularity":null,"units":"count","vintage":null,"hideInDataBrowser":true,"filteringTags":[{"id":"Gender","name":"Gender","value":"Female"}],"derivative":false,"provider":"MBR"}]}]};

package/packages/arcgis-rest-demographics/test/queryDemographicData.test.live.ts

@@ -0,0 +1,42 @@
+/* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { queryDemographicData } from "../src/queryDemographicData";
+import { ApiKey } from "../../arcgis-rest-auth";
+import 'dotenv/config';
+
+const addEnv = (params: any) => {
+  if (process.env.UNIT_TESTING_API_KEY && process.env.UNIT_TESTING_API_KEY !== '') {
+    params.authentication = new ApiKey({
+      key: process.env.UNIT_TESTING_API_KEY
+    });
+  } else {
+    console.error('Error - No API key specified in .ENV file.');
+  }
+
+  if (process.env.GEOENRICHMENTSERVER_URL && process.env.GEOENRICHMENTSERVER_URL !== '') {
+    params.endpoint = process.env.GEOENRICHMENTSERVER_URL;
+  }
+  return params;
+}
+
+describe("queryDemographicData", () => {
+  it("should make a simple, single queryDemographicData request", done => {
+    const params = addEnv({
+      studyAreas: [{ "geometry": { "x": -117.1956, "y": 34.0572 } }],
+    });
+
+    queryDemographicData(params)
+      .then(response => {
+        expect(Object.keys(response)).toContain('results');
+        expect(Object.keys(response)).toContain('messages');
+        expect(response.results.length).toBeGreaterThan(0);
+        expect(response.results[0].value.FeatureSet.length).toBeGreaterThan(0);
+        expect(response.results[0].value.FeatureSet[0].features.length).toBeGreaterThan(0);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});