ducimusipsa 1.0.0

package/packages/arcgis-rest-common-types/tsconfig.json

@@ -0,0 +1,11 @@
+{
+    "compilerOptions": {
+        "module": "es2015",
+        "declaration": true,
+        "declarationDir": "./dist/types",
+        "emitDeclarationOnly": true
+    },
+    "include": [
+        "src/**/*.ts"
+    ]
+}

package/packages/arcgis-rest-feature-service/README.md

@@ -0,0 +1,73 @@
+[![npm version][npm-img]][npm-url]
+[![build status][travis-img]][travis-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-feature-service.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-feature-service
+[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
+[coverage-img]: https://coveralls.io/repos/github/Esri/arcgis-rest-js/badge.svg
+[coverage-url]: https://coveralls.io/github/Esri/arcgis-rest-js
+
+# @esri/arcgis-rest-feature-service
+
+> A module for working with ArcGIS feature services that runs in Node.js and modern browsers.
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+npm install @esri/arcgis-rest-feature-service
+```
+
+```js
+import { getFeature } from '@esri/arcgis-rest-feature-service';
+
+const options = {
+  url:
+    "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Landscape_Trees/FeatureServer/0",
+  id: 42
+};
+
+getFeature(options)
+  .then(feature => {
+    console.log(feature.attributes.FID); // 42
+  });
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/feature-service/)
+
+### 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).
+
+### License
+
+Copyright &copy; 2017-2018 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-feature-service/package-lock.json

@@ -0,0 +1,11 @@
+{
+	"requires": true,
+	"lockfileVersion": 1,
+	"dependencies": {
+		"tslib": {
+			"version": "1.8.0",
+			"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.8.0.tgz",
+			"integrity": "sha512-ymKWWZJST0/CkgduC2qkzjMOWr4bouhuURNXCn/inEX0L57BnRG6FhX76o7FOnsjHazCjfU2LKeSrlS2sIKQJg=="
+		}
+	}
+}

package/packages/arcgis-rest-feature-service/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@esri/arcgis-rest-feature-service",
+  "version": "1.14.1",
+  "description": "Feature service helpers for @esri/arcgis-rest-request",
+  "main": "dist/node/index.js",
+  "browser": "dist/umd/feature-service.umd.js",
+  "module": "dist/esm/index.js",
+  "js:next": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "license": "Apache-2.0",
+  "files": [
+    "dist/**"
+  ],
+  "dependencies": {
+    "tslib": "^1.7.1"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-common-types": "^1.14.1",
+    "@esri/arcgis-rest-request": "^1.14.1"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-common-types": "^1.14.1",
+    "@esri/arcgis-rest-request": "^1.14.1"
+  },
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "npm run build:node && npm run build:umd && npm run build:esm",
+    "build:esm": "tsc -p ./tsconfig.json --module es2015 --outDir ./dist/esm --declaration",
+    "build:umd": "rollup -c ../../umd-base-profile.js && rollup -c ../../umd-production-profile.js",
+    "build:node": "tsc -p ./tsconfig.json --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"
+  },
+  "contributors": [
+    {
+      "name": "Tom Wayson",
+      "email": "twayson@esri.com",
+      "url": "http://tomwayson.com/"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "homepage": "https://github.com/Esri/arcgis-rest-js#readme"
+}

package/packages/arcgis-rest-feature-service/src/add.ts

@@ -0,0 +1,90 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IFeature } from "@esri/arcgis-rest-common-types";
+import {
+  request,
+  IRequestOptions,
+  appendCustomParams,
+  warn
+} from "@esri/arcgis-rest-request";
+import { IEditFeaturesParams, IEditFeatureResult } from "./helpers";
+
+/**
+ * Add features request options. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/add-features.htm) for more information.
+ *
+ * @param url - Feature service url.
+ * @param features - Array of JSON features to add.
+ * @param params - Query parameters to be sent to the feature service via the request.
+ */
+export interface IAddFeaturesRequestOptions
+  extends IEditFeaturesParams,
+    IRequestOptions {
+  /**
+   * Feature service url.
+   */
+  url: string;
+  /**
+   * Array of JSON features to add.
+   */
+  features: IFeature[];
+  /**
+   * Deprecated. Please use `features` instead.
+   */
+  adds?: IFeature[];
+}
+
+/**
+ * Add features results.
+ */
+export interface IAddFeaturesResult {
+  /**
+   * Array of JSON response Object(s) for each feature added.
+   */
+  addResults?: IEditFeatureResult[];
+}
+
+/**
+ * Add features request. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/add-features.htm) for more information.
+ *
+ * ```js
+ * import { addFeatures } from '@esri/arcgis-rest-feature-service';
+ *
+ * const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0";
+ *
+ * addFeatures({
+ *   url,
+ *   features: [{
+ *     geometry: { x: -120, y: 45, spatialReference: { wkid: 4326 } },
+ *     attributes: { status: "alive" }
+ *   }]
+ * });
+ * ```
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the addFeatures response.
+ */
+export function addFeatures(
+  requestOptions: IAddFeaturesRequestOptions
+): Promise<IAddFeaturesResult> {
+  const url = `${requestOptions.url}/addFeatures`;
+
+  // edit operations are POST only
+  const options: IAddFeaturesRequestOptions = {
+    params: {},
+    ...requestOptions
+  };
+
+  appendCustomParams(requestOptions, options);
+
+  if (options.params.adds && options.params.adds.length) {
+    // mixin, don't overwrite
+    options.params.features = requestOptions.adds;
+    delete options.params.adds;
+    warn(
+      "The `adds` parameter is deprecated and will be removed in a future release. Please use `features` instead."
+    );
+  }
+
+  return request(url, options);
+}

package/packages/arcgis-rest-feature-service/src/addAttachment.ts

@@ -0,0 +1,64 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
+import { IEditFeatureResult } from "./helpers";
+
+/**
+ * Request options for adding a related attachment to a feature by id. See [Add Attachment](https://developers.arcgis.com/rest/services-reference/add-attachment.htm) for more information.
+ *
+ */
+export interface IAddAttachmentOptions extends IRequestOptions {
+  /**
+   * Feature service url.
+   */
+  url: string;
+  /**
+   * Unique identifier of feature to add related attachment.
+   */
+  featureId: number;
+  /**
+   * File to be attached.
+   */
+  attachment: File;
+}
+
+/**
+ * `addAttachment()` request response.
+ */
+export interface IAddAttachmentResponse {
+  /**
+   * Standard AGS add/update/edit result Object for the attachment.
+   */
+  addAttachmentResult: IEditFeatureResult;
+}
+
+/**
+ * Attach a file to a feature by id. See [Add Attachment](https://developers.arcgis.com/rest/services-reference/add-attachment.htm) for more information.
+ *
+ * ```js
+ * import { addAttachment } from '@esri/arcgis-rest-feature-service';
+ *
+ * addAttachment({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   featureId: 8484,
+ *   attachment: myFileInput.files[0]
+ * });
+ * ```
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the `addAttachment()` response.
+ */
+export function addAttachment(
+  requestOptions: IAddAttachmentOptions
+): Promise<IAddAttachmentResponse> {
+  const options: IAddAttachmentOptions = {
+    params: {},
+    ...requestOptions
+  };
+
+  // `attachment` --> params: {}
+  options.params.attachment = requestOptions.attachment;
+
+  return request(`${options.url}/${options.featureId}/addAttachment`, options);
+}

package/packages/arcgis-rest-feature-service/src/decodeValues.ts

@@ -0,0 +1,129 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import {
+  IField,
+  ILayerDefinition,
+  IFeature
+} from "@esri/arcgis-rest-common-types";
+import { IQueryFeaturesResponse } from "./query";
+import { getLayer } from "./getLayer";
+
+/**
+ * Request options to fetch a feature by id.
+ */
+export interface IDecodeValuesRequestOptions extends IRequestOptions {
+  /**
+   * Layer service url.
+   */
+  url: string;
+  /**
+   * Unique identifier of the feature.
+   */
+  queryResponse: IQueryFeaturesResponse;
+  /**
+   * * If a fieldset is provided, no internal metadata check will be issued to gather info about coded value domains.
+   *
+   * getFeatureService(url)
+   *   .then(metadata => {
+   *     queryFeatures({ url })
+   *       .then(response => {
+   *         decodeValues({
+   *           url,
+   *           queryResponse,
+   *           fields: metadata.fields
+   *         })
+   *           .then(decodedResponse)
+   *       })
+   *   })
+   */
+  fields?: IField[];
+}
+
+/**
+ * Replaces the raw coded domain values in a query response with descriptions (for legibility).
+ *
+ * ```js
+ * import { queryFeatures, decodeValues } from '@esri/arcgis-rest-feature-service';
+ *
+ * const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0";
+ *
+ * queryFeatures({ url })
+ *   .then(queryResponse => {
+ *     decodeValues({
+ *       url,
+ *       queryResponse
+ *     })
+ *       .then(decodedResponse)
+ *   })
+ * ```
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the addFeatures response.
+ */
+export function decodeValues(
+  requestOptions: IDecodeValuesRequestOptions
+): Promise<IQueryFeaturesResponse> {
+  return new Promise(resolve => {
+    if (!requestOptions.fields) {
+      return getLayer(requestOptions.url, requestOptions).then(
+        (metadata: ILayerDefinition) => {
+          resolve((requestOptions.fields = metadata.fields));
+        }
+      );
+    } else {
+      resolve(requestOptions.fields);
+    }
+  }).then(fields => {
+    // extract coded value domains
+    const domains = extractCodedValueDomains(fields as IField[]);
+    if (Object.keys(domains).length < 1) {
+      // no values to decode
+      return requestOptions.queryResponse;
+    }
+
+    // don't mutate original features
+    const decodedFeatures = requestOptions.queryResponse.features.map(
+      (feature: IFeature) => {
+        const decodedAttributes: { [index: string]: any } = {};
+        for (const key in feature.attributes) {
+          /* istanbul ignore next */
+          if (!feature.attributes.hasOwnProperty(key)) continue;
+          const value = feature.attributes[key];
+          const domain = domains[key];
+          decodedAttributes[key] =
+            value !== null && domain ? decodeValue(value, domain) : value;
+        }
+        // merge decoded attributes into the feature
+        return { ...feature, ...{ attributes: decodedAttributes } };
+      }
+    );
+    // merge decoded features into the response
+    return {
+      ...requestOptions.queryResponse,
+      ...{ features: decodedFeatures }
+    };
+  });
+}
+
+function extractCodedValueDomains(fields: IField[]) {
+  return fields.reduce(
+    (domains, field) => {
+      const domain = field.domain;
+      if (domain && domain.type === "codedValue") {
+        domains[field.name] = domain;
+      }
+      return domains;
+    },
+    {} as { [index: string]: any }
+  );
+}
+
+// TODO: add type for domain?
+function decodeValue(value: any, domain: any) {
+  const codedValue = domain.codedValues.find((d: any) => {
+    return value === d.code;
+  });
+  return codedValue ? codedValue.name : value;
+}

package/packages/arcgis-rest-feature-service/src/delete.ts

@@ -0,0 +1,97 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  appendCustomParams,
+  warn
+} from "@esri/arcgis-rest-request";
+import {
+  IEditFeaturesParams,
+  IEditFeatureResult,
+  ISharedQueryParams
+} from "./helpers";
+
+/**
+ * Delete features parameters.
+ */
+export interface IDeleteFeaturesParams
+  extends IEditFeaturesParams,
+    ISharedQueryParams {}
+
+/**
+ * Delete features request options. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/delete-features.htm) for more information.
+ *
+ * @param url - Feature service url.
+ * @param objectIds - Array of objectIds to delete.
+ * @param params - Query parameters to be sent to the feature service via the request.
+ */
+export interface IDeleteFeaturesRequestOptions
+  extends IDeleteFeaturesParams,
+    IRequestOptions {
+  /**
+   * Feature service url.
+   */
+  url: string;
+  /**
+   * Array of objectIds to delete.
+   */
+  objectIds: number[];
+  /**
+   * Deprecated. Please use `objectIds` instead.
+   */
+  deletes?: number[];
+}
+
+/**
+ * Delete features results.
+ */
+export interface IDeleteFeaturesResult {
+  /**
+   * Array of JSON response Object(s) for each feature deleted.
+   */
+  deleteResults?: IEditFeatureResult[];
+}
+
+/**
+ * Delete features request. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/delete-features.htm) for more information.
+ *
+ * ```js
+ * import { deleteFeatures } from '@esri/arcgis-rest-feature-service';
+ *
+ * const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0";
+ *
+ * deleteFeatures({
+ *   url,
+ *   objectIds: [1,2,3]
+ * });
+ * ```
+ *
+ * @param deleteFeaturesRequestOptions - Options for the request.
+ * @returns A Promise that will resolve with the deleteFeatures response.
+ */
+export function deleteFeatures(
+  requestOptions: IDeleteFeaturesRequestOptions
+): Promise<IDeleteFeaturesResult> {
+  const url = `${requestOptions.url}/deleteFeatures`;
+
+  // edit operations POST only
+  const options: IDeleteFeaturesRequestOptions = {
+    params: {},
+    ...requestOptions
+  };
+
+  appendCustomParams(requestOptions, options);
+
+  if (options.params.deletes && options.params.deletes.length) {
+    // mixin, don't overwrite
+    options.params.objectIds = requestOptions.deletes;
+    delete options.params.deletes;
+    warn(
+      "The `deletes` parameter is deprecated and will be removed in a future release. Please use `objectIds` instead."
+    );
+  }
+
+  return request(url, options);
+}

package/packages/arcgis-rest-feature-service/src/deleteAttachments.ts

@@ -0,0 +1,67 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
+import { IEditFeatureResult } from "./helpers";
+
+/**
+ * Request options to for deleting related attachments of a feature by id. See [Delete Attachments](https://developers.arcgis.com/rest/services-reference/delete-attachments.htm) for more information.
+ *
+ */
+export interface IDeleteAttachmentsOptions extends IRequestOptions {
+  /**
+   * Feature service url.
+   */
+  url: string;
+  /**
+   * Unique identifier of feature to delete related attachment(s).
+   */
+  featureId: number;
+  /**
+   * Array of unique identifiers of attachments to delete.
+   */
+  attachmentIds: number[];
+}
+
+/**
+ * `updateAttachment()` request response.
+ */
+export interface IDeleteAttachmentsResponse {
+  /**
+   * Array of standard AGS add/update/edit result Object(s) for the attachment(s).
+   */
+  deleteAttachmentResults: IEditFeatureResult[];
+}
+
+/**
+ * Delete existing attachment files of a feature by id. See [Delete Attachments](https://developers.arcgis.com/rest/services-reference/delete-attachments.htm) for more information.
+ *
+ * ```js
+ * import { deleteAttachments } from '@esri/arcgis-rest-feature-service';
+ *
+ * deleteAttachments({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   featureId: 8484,
+ *   attachmentIds: [306]
+ * });
+ * ```
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the `deleteAttachments()` response.
+ */
+export function deleteAttachments(
+  requestOptions: IDeleteAttachmentsOptions
+): Promise<IDeleteAttachmentsResponse> {
+  const options: IDeleteAttachmentsOptions = {
+    params: {},
+    ...requestOptions
+  };
+
+  // `attachmentIds` --> params: {}
+  options.params.attachmentIds = requestOptions.attachmentIds;
+
+  return request(
+    `${options.url}/${options.featureId}/deleteAttachments`,
+    options
+  );
+}

package/packages/arcgis-rest-feature-service/src/getAttachments.ts

@@ -0,0 +1,64 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
+
+/**
+ * Request options to fetch `attachmentInfos` of a feature by id. See [Attachment Infos](https://developers.arcgis.com/rest/services-reference/attachment-infos-feature-service-.htm) for more information.
+ *
+ */
+export interface IGetAttachmentsOptions extends IRequestOptions {
+  /**
+   * Feature service url.
+   */
+  url: string;
+  /**
+   * Unique identifier of feature to request related `attachmentInfos`.
+   */
+  featureId: number;
+}
+
+/**
+ * Attachment, a.k.a. `attachmentInfo`. See [Attachment](https://developers.arcgis.com/rest/services-reference/attachment-feature-service-.htm) for more information.
+ */
+export interface IAttachmentInfo {
+  id: number;
+  contentType: string;
+  size: number;
+  name: string;
+}
+
+/**
+ * `getAttachments()` request response.
+ */
+export interface IGetAttachmentsResponse {
+  /**
+   * Array of `attachmentInfo` Object(s) for each related attachment. Empty Array means no attachments.
+   */
+  attachmentInfos: IAttachmentInfo[];
+}
+
+/**
+ * Request `attachmentInfos` of a feature by id. See [Attachment Infos](https://developers.arcgis.com/rest/services-reference/attachment-infos-feature-service-.htm) for more information.
+ *
+ * ```js
+ * import { getAttachments } from '@esri/arcgis-rest-feature-service';
+ *
+ * getAttachments({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   featureId: 8484
+ * });
+ * ```
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the `getAttachments()` response.
+ */
+export function getAttachments(
+  requestOptions: IGetAttachmentsOptions
+): Promise<IGetAttachmentsResponse> {
+  // pass through
+  return request(
+    `${requestOptions.url}/${requestOptions.featureId}/attachments`,
+    requestOptions
+  );
+}

package/packages/arcgis-rest-feature-service/src/getLayer.ts

@@ -0,0 +1,27 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
+import { ILayerDefinition } from "@esri/arcgis-rest-common-types";
+
+/**
+ * Layer (Feature Service) request. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/layer-feature-service-.htm) for more information.
+ *
+ * ```js
+ * import { getLayer } from '@esri/arcgis-rest-feature-service';
+ *
+ * const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0";
+ *
+ * getLayer(url)
+ *   .then(response) // { name: "311", id: 0, ... }
+ * ```
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the addFeatures response.
+ */
+export function getLayer(
+  url: string,
+  requestOptions?: IRequestOptions
+): Promise<ILayerDefinition> {
+  return request(url, requestOptions);
+}