ducimusipsa 1.0.0

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

@@ -0,0 +1,50 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { appendCustomParams } from "@esri/arcgis-rest-request";
+
+import {
+  esriGeometryType,
+  SpatialRelationship,
+  IGeometry,
+  ISpatialReference
+} from "@esri/arcgis-rest-common-types";
+
+export interface ISharedQueryParams {
+  where?: string;
+  geometry?: IGeometry;
+  geometryType?: esriGeometryType;
+  // NOTE: either WKID or ISpatialReference
+  inSR?: string | ISpatialReference;
+  spatialRel?: SpatialRelationship;
+}
+
+/**
+ * Add, update and delete features result Object.
+ */
+export interface IEditFeatureResult {
+  objectId: number;
+  globalId?: string;
+  success: boolean;
+}
+
+/**
+ * Common add and update features parameters.
+ */
+export interface IEditFeaturesParams {
+  /**
+   * The geodatabase version to apply the edits.
+   */
+  gdbVersion?: string;
+  /**
+   * Optional parameter specifying whether the response will report the time features were added.
+   */
+  returnEditMoment?: boolean;
+  /**
+   * Optional parameter to specify if the edits should be applied only if all submitted edits succeed.
+   */
+  rollbackOnFailure?: boolean;
+}
+
+// this function has been moved into @esri/request. it is re-exported here for backwards compatibility
+export { appendCustomParams };

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

@@ -0,0 +1,14 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export * from "./query";
+export * from "./add";
+export * from "./update";
+export * from "./delete";
+export * from "./getAttachments";
+export * from "./addAttachment";
+export * from "./updateAttachment";
+export * from "./deleteAttachments";
+export * from "./queryRelated";
+export * from "./getLayer";
+export * from "./decodeValues";

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

@@ -0,0 +1,183 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+import {
+  ISpatialReference,
+  IFeatureSet,
+  IFeature,
+  esriUnits,
+  IExtent
+} from "@esri/arcgis-rest-common-types";
+
+import { ISharedQueryParams } from "./helpers";
+
+/**
+ * Request options to fetch a feature by id.
+ */
+export interface IFeatureRequestOptions extends IRequestOptions {
+  /**
+   * Layer service url.
+   */
+  url: string;
+  /**
+   * Unique identifier of the feature.
+   */
+  id: number;
+}
+
+export interface IStatisticDefinition {
+  /**
+   * Statistical operation to perform (count, sum, min, max, avg, stddev, var).
+   */
+  statisticType: "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var";
+  /**
+   * Field on which to perform the statistical operation.
+   */
+  onStatisticField: string;
+  /**
+   * Field name for the returned statistic field. If outStatisticFieldName is empty or missing, the server will assign one. A valid field name can only contain alphanumeric characters and an underscore. If the outStatisticFieldName is a reserved keyword of the underlying DBMS, the operation can fail. Try specifying an alternative outStatisticFieldName.
+   */
+  outStatisticFieldName: string;
+}
+
+/**
+ * feature query request options. See [REST Documentation](https://developers.arcgis.com/rest/services-reference/query-feature-service-layer-.htm) for more information.
+ */
+export interface IQueryFeaturesRequestOptions
+  extends ISharedQueryParams,
+    IRequestOptions {
+  /**
+   * Layer service url.
+   */
+  url: string;
+  objectIds?: number[];
+  relationParam?: string;
+  // NOTE: either time=1199145600000 or time=1199145600000, 1230768000000
+  time?: number | number[];
+  distance?: number;
+  units?: esriUnits;
+  outFields?: "*" | string[];
+  returnGeometry?: boolean;
+  maxAllowableOffset?: number;
+  geometryPrecision?: number;
+  // NOTE: either WKID or ISpatialReference
+  outSR?: string | ISpatialReference;
+  gdbVersion?: string;
+  returnDistinctValues?: boolean;
+  returnIdsOnly?: boolean;
+  returnCountOnly?: boolean;
+  returnExtentOnly?: boolean;
+  orderByFields?: string;
+  groupByFieldsForStatistics?: string;
+  outStatistics?: IStatisticDefinition[];
+  returnZ?: boolean;
+  returnM?: boolean;
+  multipatchOption?: "xyFootprint";
+  resultOffset?: number;
+  resultRecordCount?: number;
+  // TODO: IQuantizationParameters?
+  quantizationParameters?: any;
+  returnCentroid?: boolean;
+  resultType?: "none" | "standard" | "tile";
+  // to do: convert from Date() to epoch time internally
+  historicMoment?: number;
+  returnTrueCurves?: false;
+  sqlFormat?: "none" | "standard" | "native";
+  returnExceededLimitFeatures?: boolean;
+  /**
+   * someday...
+   *
+   * If 'true' the query will be preceded by a metadata check to gather info about coded value domains and result values will be decoded. If a fieldset is provided it will be used to decode values and no internal metadata request will be issued.
+   */
+  // decodeValues?: boolean | IField[];
+}
+
+export interface IQueryFeaturesResponse extends IFeatureSet {
+  exceededTransferLimit?: boolean;
+}
+
+export interface IQueryResponse {
+  count?: number;
+  extent?: IExtent;
+  objectIdFieldName?: string;
+  objectIds?: number[];
+}
+
+/**
+ * Get a feature by id.
+ *
+ * ```js
+ * import { getFeature } from '@esri/arcgis-rest-feature-service';
+ *
+ * const url = "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Landscape_Trees/FeatureServer/0";
+ *
+ * getFeature({
+ *   url,
+ *   id: 42
+ * }).then(feature => {
+ *  console.log(feature.attributes.FID); // 42
+ * });
+ * ```
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the feature.
+ */
+export function getFeature(
+  requestOptions: IFeatureRequestOptions
+): Promise<IFeature> {
+  const url = `${requestOptions.url}/${requestOptions.id}`;
+
+  // default to a GET request
+  const options: IFeatureRequestOptions = {
+    ...{ httpMethod: "GET" },
+    ...requestOptions
+  };
+  return request(url, options).then((response: any) => response.feature);
+}
+
+/**
+ * Query a feature service. See [REST Documentation](https://developers.arcgis.com/rest/services-reference/query-feature-service-layer-.htm) for more information.
+ *
+ * ```js
+ * import { queryFeatures } from '@esri/arcgis-rest-feature-service';
+ *
+ * const url = "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3";
+ *
+ * queryFeatures({
+ *   url,
+ *   where: "STATE_NAME = 'Alaska'"
+ * }).then(result => {
+ *   console.log(result.features); // array of features
+ * });
+ * ```
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the query response.
+ */
+export function queryFeatures(
+  requestOptions: IQueryFeaturesRequestOptions
+): Promise<IQueryFeaturesResponse | IQueryResponse> {
+  const queryOptions: IQueryFeaturesRequestOptions = {
+    params: {},
+    httpMethod: "GET",
+    url: requestOptions.url,
+    ...requestOptions
+  };
+
+  appendCustomParams(requestOptions, queryOptions);
+
+  // set default query parameters
+  if (!queryOptions.params.where) {
+    queryOptions.params.where = "1=1";
+  }
+  if (!queryOptions.params.outFields) {
+    queryOptions.params.outFields = "*";
+  }
+
+  return request(`${queryOptions.url}/query`, queryOptions);
+}

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

@@ -0,0 +1,94 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+import {
+  ISpatialReference,
+  IFeature,
+  IHasZM,
+  esriGeometryType,
+  IField
+} from "@esri/arcgis-rest-common-types";
+
+/**
+ * Related record query request options. Additional arguments can be passed via the [params](/arcgis-rest-js/api/feature-service/IQueryRelatedRequestOptions/#params) property. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/query-related-feature-service-.htm) for more information and a full list of parameters.
+ */
+export interface IQueryRelatedRequestOptions extends IRequestOptions {
+  url: string;
+  relationshipId?: number;
+  objectIds?: number[];
+  outFields?: "*" | string[];
+  definitionExpression?: string;
+}
+
+/**
+ * Related record data structure
+ */
+
+export interface IRelatedRecordGroup {
+  objectId: number;
+  relatedRecords?: IFeature[];
+  count?: number;
+}
+
+/**
+ * Related record response structure
+ */
+
+export interface IQueryRelatedResponse extends IHasZM {
+  geometryType?: esriGeometryType;
+  spatialReference?: ISpatialReference;
+  fields?: IField[];
+  relatedRecordGroups: IRelatedRecordGroup[];
+}
+/**
+ * Query the related records for a feature service. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/query-related-records-feature-service-.htm) for more information.
+ *
+ * ```js
+ * import { queryRelated } from '@esri/arcgis-rest-feature-service'
+ *
+ * const url = "http://services.myserver/OrgID/ArcGIS/rest/services/Petroleum/KSPetro/FeatureServer/0"
+ *
+ * queryRelated({
+ *  url: url,
+ *  relationshipId: 1,
+ *  params: { returnCountOnly: true }
+ * })
+ *  .then(response => {
+ *    console.log(response.relatedRecords)
+ *  })
+ * ```
+ *
+ * @param requestOptions
+ * @returns A Promise that will resolve with the query response
+ */
+export function queryRelated(
+  requestOptions: IQueryRelatedRequestOptions
+): Promise<IQueryRelatedResponse> {
+  const options: IQueryRelatedRequestOptions = {
+    params: {},
+    httpMethod: "GET",
+    url: requestOptions.url,
+    ...requestOptions
+  };
+
+  appendCustomParams(requestOptions, options);
+
+  if (!options.params.definitionExpression) {
+    options.params.definitionExpression = "1=1";
+  }
+
+  if (!options.params.outFields) {
+    options.params.outFields = "*";
+  }
+
+  if (!options.params.relationshipId) {
+    options.params.relationshipId = 0;
+  }
+
+  return request(`${options.url}/queryRelatedRecords`, options);
+}

package/packages/arcgis-rest-feature-service/src/update.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";
+
+/**
+ * Update features request options. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/update-features.htm) for more information.
+ *
+ * @param url - Feature service url.
+ * @param features - Array of JSON features to update.
+ * @param params - Query parameters to be sent to the feature service via the request.
+ */
+export interface IUpdateFeaturesRequestOptions
+  extends IEditFeaturesParams,
+    IRequestOptions {
+  /**
+   * Feature service url.
+   */
+  url: string;
+  /**
+   * Array of JSON features to update.
+   */
+  features: IFeature[];
+  /**
+   * Deprecated. Please use `features` instead.
+   */
+  updates?: IFeature[];
+}
+
+/**
+ * Update features results.
+ */
+export interface IUpdateFeaturesResult {
+  /**
+   * Array of JSON response Object(s) for each feature updated.
+   */
+  updateResults?: IEditFeatureResult[];
+}
+
+/**
+ * Update features request. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/update-features.htm) for more information.
+ *
+ * ```js
+ * import { updateFeatures } from '@esri/arcgis-rest-feature-service';
+ *
+ * const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0";
+ *
+ * updateFeatures({
+ *   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 updateFeatures response.
+ */
+export function updateFeatures(
+  requestOptions: IUpdateFeaturesRequestOptions
+): Promise<IUpdateFeaturesResult> {
+  const url = `${requestOptions.url}/updateFeatures`;
+
+  // edit operations are POST only
+  const options: IUpdateFeaturesRequestOptions = {
+    params: {},
+    ...requestOptions
+  };
+
+  appendCustomParams(requestOptions, options);
+
+  if (options.params.updates && options.params.updates.length) {
+    // mixin, don't overwrite
+    options.params.features = requestOptions.updates;
+    delete options.params.updates;
+    warn(
+      "The `updates` 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/updateAttachment.ts

@@ -0,0 +1,73 @@
+/* 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 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 IRequestOptions {
+  /**
+   * Feature service url.
+   */
+  url: string;
+  /**
+   * Unique identifier of feature to update related attachment.
+   */
+  featureId: number;
+  /**
+   * File to be updated.
+   */
+  attachment: File;
+  /**
+   * Unique identifier of the attachment.
+   */
+  attachmentId: number;
+}
+
+/**
+ * `updateAttachment()` request response.
+ */
+export interface IUpdateAttachmentResponse {
+  /**
+   * Standard AGS add/update/edit result Object for the attachment.
+   */
+  updateAttachmentResult: IEditFeatureResult;
+}
+
+/**
+ * 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.
+ *
+ * ```js
+ * import { updateAttachment } from '@esri/arcgis-rest-feature-service';
+ *
+ * updateAttachment({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   featureId: 8484,
+ *   attachment: myFileInput.files[0],
+ *   attachmentId: 306
+ * });
+ * ```
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the `updateAttachment()` response.
+ */
+export function updateAttachment(
+  requestOptions: IUpdateAttachmentOptions
+): Promise<IUpdateAttachmentResponse> {
+  const options: IUpdateAttachmentOptions = {
+    params: {},
+    ...requestOptions
+  };
+
+  // `attachment` and `attachmentId` --> params: {}
+  options.params.attachment = requestOptions.attachment;
+  options.params.attachmentId = requestOptions.attachmentId;
+
+  return request(
+    `${options.url}/${options.featureId}/updateAttachment`,
+    options
+  );
+}