sintfacilis 1.0.0

package/packages/arcgis-rest-feature-layer/src/updateAttachment.ts

@@ -0,0 +1,59 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, cleanUrl } from "@esri/arcgis-rest-request";
+import { IGetLayerOptions, IEditFeatureResult } from "./helpers";
+
+/**
+ * Request options to for updating a related attachment to a feature by id. See [Update Attachment](https://developers.arcgis.com/rest/services-reference/update-attachment.htm) for more information.
+ *
+ */
+export interface IUpdateAttachmentOptions extends IGetLayerOptions {
+  /**
+   * Unique identifier of feature to update related attachment.
+   */
+  featureId: number;
+  /**
+   * File to be updated.
+   */
+  attachment: File;
+  /**
+   * Unique identifier of the attachment.
+   */
+  attachmentId: number;
+}
+
+/**
+ *
+ * ```js
+ * import { updateAttachment } from '@esri/arcgis-rest-feature-layer';
+ * //
+ * updateAttachment({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   featureId: 8484,
+ *   attachment: myFileInput.files[0],
+ *   attachmentId: 306
+ * });
+ * ```
+ * Update a related attachment to a feature by id. See [Update Attachment](https://developers.arcgis.com/rest/services-reference/update-attachment.htm) for more information.
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the `updateAttachment()` response.
+ */
+export function updateAttachment(
+  requestOptions: IUpdateAttachmentOptions
+): Promise<{ updateAttachmentResult: IEditFeatureResult }> {
+  const options: IUpdateAttachmentOptions = {
+    params: {},
+    ...requestOptions
+  };
+
+  // `attachment` and `attachmentId` --> params: {}
+  options.params.attachment = requestOptions.attachment;
+  options.params.attachmentId = requestOptions.attachmentId;
+
+  return request(
+    `${cleanUrl(options.url)}/${options.featureId}/updateAttachment`,
+    options
+  );
+}

package/packages/arcgis-rest-feature-layer/test/attachments.test.ts

@@ -0,0 +1,200 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import * as fetchMock from "fetch-mock";
+
+import {
+  getAttachments,
+  IGetAttachmentsOptions,
+  addAttachment,
+  IAddAttachmentOptions,
+  updateAttachment,
+  IUpdateAttachmentOptions,
+  deleteAttachments,
+  IDeleteAttachmentsOptions
+} from "../src/index";
+
+import {
+  getAttachmentsResponse,
+  addAttachmentResponse,
+  updateAttachmentResponse,
+  deleteAttachmentsResponse,
+  genericInvalidResponse
+} from "./mocks/feature";
+
+export function attachmentFile() {
+  if (typeof File !== "undefined" && File) {
+    return new File(["foo"], "foo.txt", { type: "text/plain" });
+  } else {
+    const fs = require("fs");
+    return fs.createReadStream(
+      "./packages/arcgis-rest-feature-layer/test/mocks/foo.txt"
+    );
+  }
+}
+
+const serviceUrl =
+  "https://services.arcgis.com/f8b/arcgis/rest/services/Custom/FeatureServer/0";
+
+describe("attachment methods", () => {
+  afterEach(fetchMock.restore);
+
+  it("should return an array of attachmentInfos for a feature by id", done => {
+    const requestOptions = {
+      url: serviceUrl,
+      featureId: 42,
+      params: {
+        gdbVersion: "SDE.DEFAULT"
+      }
+    } as IGetAttachmentsOptions;
+    fetchMock.once("*", getAttachmentsResponse);
+    getAttachments(requestOptions)
+      .then(() => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/attachments?f=json&gdbVersion=SDE.DEFAULT`
+        );
+        expect(options.method).toBe("GET");
+        expect(getAttachmentsResponse.attachmentInfos.length).toEqual(2);
+        expect(getAttachmentsResponse.attachmentInfos[0].id).toEqual(409);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should return objectId of the added attachment and a truthy success", done => {
+    const requestOptions = {
+      url: serviceUrl,
+      featureId: 42,
+      attachment: attachmentFile(),
+      params: {
+        returnEditMoment: true
+      }
+    } as IAddAttachmentOptions;
+    fetchMock.once("*", addAttachmentResponse);
+    addAttachment(requestOptions)
+      .then(() => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/addAttachment`
+        );
+        expect(options.method).toBe("POST");
+
+        const params = options.body as FormData;
+        expect(params instanceof FormData).toBeTruthy();
+        // we can introspect FormData in Chrome this way, but not Node.js
+        // more info: https://github.com/form-data/form-data/issues/124
+        if (params.get) {
+          expect(params.get("returnEditMoment")).toEqual("true");
+        }
+        expect(addAttachmentResponse.addAttachmentResult.objectId).toEqual(
+          1001
+        );
+        expect(addAttachmentResponse.addAttachmentResult.success).toEqual(true);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should return an error for a service/feature which does not have attachments", done => {
+    const requestOptions = {
+      url:
+        "https://services.arcgis.com/f8b/arcgis/rest/services/NoAttachments/FeatureServer/0",
+      featureId: 654,
+      attachment: attachmentFile(),
+      params: {
+        returnEditMoment: true
+      }
+    } as IAddAttachmentOptions;
+    fetchMock.once("*", genericInvalidResponse);
+    addAttachment(requestOptions)
+      .then(() => {
+        // nothing to test here forcing error
+        fail();
+      })
+      .catch(error => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/addAttachment`
+        );
+        expect(options.method).toBe("POST");
+        expect(error.response.error.code).toEqual(400);
+        expect(error.response.error.message).toEqual(
+          "Invalid or missing input parameters."
+        );
+        done();
+      });
+  });
+
+  it("should return objectId of the updated attachment and a truthy success", done => {
+    const requestOptions = {
+      url: serviceUrl,
+      featureId: 42,
+      attachmentId: 1001,
+      attachment: attachmentFile(),
+      params: {
+        returnEditMoment: true
+      }
+    } as IUpdateAttachmentOptions;
+    fetchMock.once("*", updateAttachmentResponse);
+    updateAttachment(requestOptions)
+      .then(() => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/updateAttachment`
+        );
+        expect(options.method).toBe("POST");
+        expect(
+          updateAttachmentResponse.updateAttachmentResult.objectId
+        ).toEqual(1001);
+        expect(updateAttachmentResponse.updateAttachmentResult.success).toEqual(
+          true
+        );
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should return objectId of the deleted attachment and a truthy success", done => {
+    const requestOptions = {
+      url: serviceUrl,
+      featureId: 42,
+      attachmentIds: [1001],
+      params: {
+        returnEditMoment: true
+      }
+    } as IDeleteAttachmentsOptions;
+    fetchMock.once("*", deleteAttachmentsResponse);
+    deleteAttachments(requestOptions)
+      .then(() => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/deleteAttachments`
+        );
+        expect(options.body).toContain("attachmentIds=1001");
+        expect(options.body).toContain("returnEditMoment=true");
+        expect(options.method).toBe("POST");
+        expect(
+          deleteAttachmentsResponse.deleteAttachmentResults[0].objectId
+        ).toEqual(1001);
+        expect(
+          deleteAttachmentsResponse.deleteAttachmentResults[0].success
+        ).toEqual(true);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

package/packages/arcgis-rest-feature-layer/test/crud.test.ts

@@ -0,0 +1,197 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  addFeatures,
+  updateFeatures,
+  deleteFeatures,
+  applyEdits,
+  IDeleteFeaturesOptions,
+  IUpdateFeaturesOptions
+} from "../src/index";
+
+import * as fetchMock from "fetch-mock";
+
+import {
+  addFeaturesResponse,
+  updateFeaturesResponse,
+  deleteFeaturesResponse,
+  applyEditsResponse
+} from "./mocks/feature";
+
+const serviceUrl =
+  "https://services.arcgis.com/f8b/arcgis/rest/services/Custom/FeatureServer/0";
+
+describe("feature", () => {
+  afterEach(fetchMock.restore);
+
+  it("should return objectId of the added feature and a truthy success", done => {
+    const requestOptions = {
+      url: serviceUrl,
+      features: [
+        {
+          geometry: {
+            x: -9177311.62541634,
+            y: 4247151.205222242,
+            spatialReference: {
+              wkid: 102100,
+              latestWkid: 3857
+            }
+          },
+          attributes: {
+            Tree_ID: 102,
+            Collected: 1349395200000,
+            Crew: "Linden+ Forrest+ Johnny"
+          }
+        }
+      ]
+    };
+    fetchMock.once("*", addFeaturesResponse);
+    addFeatures(requestOptions)
+      .then(response => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(`${requestOptions.url}/addFeatures`);
+        expect(options.body).toContain(
+          "features=" +
+            encodeURIComponent(
+              '[{"geometry":{"x":-9177311.62541634,"y":4247151.205222242,"spatialReference":{"wkid":102100,"latestWkid":3857}},"attributes":{"Tree_ID":102,"Collected":1349395200000,"Crew":"Linden+ Forrest+ Johnny"}}]'
+            )
+        );
+        expect(options.method).toBe("POST");
+        expect(response.addResults[0].objectId).toEqual(1001);
+        expect(response.addResults[0].success).toEqual(true);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should return objectId of the updated feature and a truthy success", done => {
+    const requestOptions = {
+      url: serviceUrl,
+      features: [
+        {
+          attributes: {
+            OBJECTID: 1001,
+            Street: "NO",
+            Native: "YES"
+          }
+        }
+      ],
+      rollbackOnFailure: false,
+      trueCurveClient: false
+    } as IUpdateFeaturesOptions;
+    fetchMock.once("*", updateFeaturesResponse);
+    updateFeatures(requestOptions)
+      .then(response => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(`${requestOptions.url}/updateFeatures`);
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain(
+          "features=" +
+            encodeURIComponent(
+              '[{"attributes":{"OBJECTID":1001,"Street":"NO","Native":"YES"}}]'
+            )
+        );
+        expect(options.body).toContain("rollbackOnFailure=false");
+        expect(options.body).toContain("trueCurveClient=false");
+        expect(response.updateResults[0].success).toEqual(true);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should return objectId of the deleted feature and a truthy success", done => {
+    const requestOptions = {
+      url: serviceUrl,
+      objectIds: [1001],
+      where: "1=1"
+    } as IDeleteFeaturesOptions;
+    fetchMock.once("*", deleteFeaturesResponse);
+    deleteFeatures(requestOptions)
+      .then(response => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(`${requestOptions.url}/deleteFeatures`);
+        expect(options.body).toContain("objectIds=1001");
+        expect(options.body).toContain("where=1%3D1");
+        expect(options.method).toBe("POST");
+        expect(response.deleteResults[0].objectId).toEqual(
+          requestOptions.objectIds[0]
+        );
+        expect(response.deleteResults[0].success).toEqual(true);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should return objectId of the added, updated or deleted feature(s) and a truthy success", done => {
+    const requestOptions = {
+      url: serviceUrl,
+      adds: [
+        {
+          geometry: {
+            x: -9177311.62541634,
+            y: 4247151.205222242,
+            spatialReference: {
+              wkid: 102100,
+              latestWkid: 3857
+            }
+          },
+          attributes: {
+            Tree_ID: 102,
+            Collected: 1349395200000,
+            Crew: "Linden+ Forrest+ Johnny"
+          }
+        }
+      ],
+      updates: [
+        {
+          attributes: {
+            OBJECTID: 1001,
+            Crew: "Tom+ Patrick+ Dave"
+          }
+        }
+      ],
+      deletes: [455]
+    };
+    fetchMock.once("*", applyEditsResponse);
+    applyEdits(requestOptions)
+      .then(response => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(`${requestOptions.url}/applyEdits`);
+        expect(options.method).toBe("POST");
+        expect(options.body).toContain(
+          "adds=" +
+            encodeURIComponent(
+              '[{"geometry":{"x":-9177311.62541634,"y":4247151.205222242,"spatialReference":{"wkid":102100,"latestWkid":3857}},"attributes":{"Tree_ID":102,"Collected":1349395200000,"Crew":"Linden+ Forrest+ Johnny"}}]'
+            )
+        );
+        expect(options.body).toContain(
+          "updates=" +
+            encodeURIComponent(
+              '[{"attributes":{"OBJECTID":1001,"Crew":"Tom+ Patrick+ Dave"}}]'
+            )
+        );
+        expect(options.body).toContain("deletes=455");
+        expect(response.addResults[0].objectId).toEqual(2156);
+        expect(response.addResults[0].success).toEqual(true);
+        expect(response.updateResults[0].objectId).toEqual(1001);
+        expect(response.updateResults[0].success).toEqual(true);
+        expect(response.deleteResults[0].objectId).toEqual(455);
+        expect(response.deleteResults[0].success).toEqual(true);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

package/packages/arcgis-rest-feature-layer/test/decodeValues.test.ts

@@ -0,0 +1,67 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { decodeValues } from "../src/decodeValues";
+
+import * as fetchMock from "fetch-mock";
+
+import {
+  cvdQueryResponse,
+  cvdFeaturesFormatted
+} from "./mocks/cvdQueryResponse";
+import { cvdServiceFields, serviceFields } from "./mocks/fields";
+import { getFeatureServiceResponse } from "./mocks/service";
+import { queryResponse } from "./mocks/feature";
+
+const serviceUrl =
+  "https://services.arcgis.com/f8b/arcgis/rest/services/Custom/FeatureServer/0";
+
+describe("formatCodedValues()", () => {
+  afterEach(fetchMock.restore);
+
+  it("should format the cvd codes in a raw response", done => {
+    decodeValues({
+      url: serviceUrl,
+      fields: cvdServiceFields,
+      queryResponse: cvdQueryResponse
+    })
+      .then(response => {
+        expect(response.features[0]).toEqual(cvdFeaturesFormatted[0]);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should return the original response if there are no coded value domains", done => {
+    decodeValues({
+      url: serviceUrl,
+      fields: serviceFields,
+      queryResponse
+    })
+      .then(response => {
+        expect(response).toEqual(queryResponse);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should fetch metadata and then format cvd codes in a raw response", done => {
+    fetchMock.once("*", getFeatureServiceResponse);
+
+    decodeValues({
+      url: serviceUrl,
+      queryResponse: cvdQueryResponse
+    })
+      .then(response => {
+        expect(response.features[0]).toEqual(cvdFeaturesFormatted[0]);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

package/packages/arcgis-rest-feature-layer/test/getAllLayersAndTables.test.ts

@@ -0,0 +1,28 @@
+import { getAllLayersAndTables } from "../src/getAllLayersAndTables";
+
+import * as fetchMock from "fetch-mock";
+
+import { allLayersAndTablesResponse } from "./mocks/allLayersAndTablesResponse";
+
+const layerUrlBase =
+  "https://services.arcgis.com/f8b/arcgis/rest/services/Custom/FeatureServer";
+
+describe("getAllLayersAndTables()", () => {
+  afterEach(fetchMock.restore);
+
+  it("should fetch all layers and table associated with the service", done => {
+    fetchMock.once("*", allLayersAndTablesResponse);
+    getAllLayersAndTables({ url: layerUrlBase + '/0' })
+      .then(response => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(layerUrlBase + '/layers');
+        expect(options.method).toBe("POST");
+        expect(response).toEqual(allLayersAndTablesResponse);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

package/packages/arcgis-rest-feature-layer/test/getLayer.test.ts

@@ -0,0 +1,31 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { getLayer } from "../src/getLayer";
+
+import * as fetchMock from "fetch-mock";
+
+import { getFeatureServiceResponse } from "./mocks/service";
+
+const layerUrl =
+  "https://services.arcgis.com/f8b/arcgis/rest/services/Custom/FeatureServer/0";
+
+describe("feature", () => {
+  afterEach(fetchMock.restore);
+
+  it("should fetch service metadata", done => {
+    fetchMock.once("*", getFeatureServiceResponse);
+    getLayer({ url: layerUrl })
+      .then(response => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(layerUrl);
+        expect(options.method).toBe("POST");
+        expect(response).toEqual(getFeatureServiceResponse);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

package/packages/arcgis-rest-feature-layer/test/getService.test.ts

@@ -0,0 +1,31 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { getService } from "../src/getService";
+
+import * as fetchMock from "fetch-mock";
+
+import { getFeatureServerResponse } from "./mocks/service";
+
+const layerUrl =
+  "https://services.arcgis.com/f8b/arcgis/rest/services/Custom/FeatureServer";
+
+describe("getServer()", () => {
+  afterEach(fetchMock.restore);
+
+  it("should fetch feature service metadata", done => {
+    fetchMock.once("*", getFeatureServerResponse);
+    getService({ url: layerUrl })
+      .then(response => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(layerUrl);
+        expect(options.method).toBe("POST");
+        expect(response).toEqual(getFeatureServerResponse);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});

package/packages/arcgis-rest-feature-layer/test/helpers.test.ts

@@ -0,0 +1,25 @@
+import { parseServiceUrl } from "../src/helpers";
+
+describe("parseServiceUrl", () => {
+  it("Trims service url to root", done => {
+    const input = "https://gis.tempe.gov/arcgis/rest/services/Covid_Cases/FeatureServer/layers?f=json";
+    const expected = "https://gis.tempe.gov/arcgis/rest/services/Covid_Cases/FeatureServer"
+    const actual = parseServiceUrl(input);
+    expect(actual).toBe(expected);
+    done();
+  });
+  it("Removes query string from non-standard service url", done => {
+    const input = "https://gis.tempe.gov/arcgis/non/traditional/path?f=json";
+    const expected = "https://gis.tempe.gov/arcgis/non/traditional/path";
+    const actual = parseServiceUrl(input);
+    expect(actual).toBe(expected);
+    done();
+  });
+  it("Removes trailing slash from non-standard service url", done => {
+    const input = "https://gis.tempe.gov/arcgis/non/traditional/path/";
+    const expected = "https://gis.tempe.gov/arcgis/non/traditional/path";
+    const actual = parseServiceUrl(input);
+    expect(actual).toBe(expected);
+    done();
+  });
+});