aspernaturalias 1.0.0

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

@@ -0,0 +1,52 @@
+/* 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 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 IGetLayerOptions {
+  /**
+   * Unique identifier of feature to delete related attachment(s).
+   */
+  featureId: number;
+  /**
+   * Array of unique identifiers of attachments to delete.
+   */
+  attachmentIds: number[];
+}
+
+/**
+ * ```js
+ * import { deleteAttachments } from '@esri/arcgis-rest-feature-layer';
+ * //
+ * deleteAttachments({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   featureId: 8484,
+ *   attachmentIds: [306]
+ * });
+ * ```
+ * 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.
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the `deleteAttachments()` response.
+ */
+export function deleteAttachments(
+  requestOptions: IDeleteAttachmentsOptions
+): Promise<{ deleteAttachmentResults: IEditFeatureResult[] }> {
+  const options: IDeleteAttachmentsOptions = {
+    params: {},
+    ...requestOptions
+  };
+
+  // `attachmentIds` --> params: {}
+  options.params.attachmentIds = requestOptions.attachmentIds;
+
+  return request(
+    `${cleanUrl(options.url)}/${options.featureId}/deleteAttachments`,
+    options
+  );
+}

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

@@ -0,0 +1,55 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, cleanUrl } from "@esri/arcgis-rest-request";
+import { IGetLayerOptions } from "./helpers";
+
+/**
+ * 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 IGetLayerOptions {
+  /**
+   * 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;
+}
+
+/**
+ * ```js
+ * import { getAttachments } from '@esri/arcgis-rest-feature-layer';
+ * //
+ * getAttachments({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   featureId: 8484
+ * });
+ * ```
+ * 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.
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the `getAttachments()` response.
+ */
+export function getAttachments(
+  requestOptions: IGetAttachmentsOptions
+): Promise<{ attachmentInfos: IAttachmentInfo[] }> {
+  const options: IGetAttachmentsOptions = {
+    httpMethod: "GET",
+    ...requestOptions
+  };
+
+  // pass through
+  return request(
+    `${cleanUrl(options.url)}/${options.featureId}/attachments`,
+    options
+  );
+}

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

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

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

@@ -0,0 +1,55 @@
+/* Copyright (c) 2017-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import {
+  GeometryType,
+  SpatialRelationship,
+  IGeometry,
+  ISpatialReference
+} from "@esri/arcgis-rest-types";
+
+/**
+ * Base options for making requests against feature layers
+ */
+export interface IGetLayerOptions extends IRequestOptions {
+  /**
+   * Layer service url.
+   */
+  url: string;
+}
+
+export interface ISharedQueryOptions extends IGetLayerOptions {
+  where?: string;
+  geometry?: IGeometry;
+  geometryType?: GeometryType;
+  // 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, update, and delete features options.
+ */
+export interface ISharedEditOptions extends IGetLayerOptions {
+  /**
+   * 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;
+}

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

@@ -0,0 +1,28 @@
+/* Copyright (c) 2018-2019 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";
+export * from "./helpers";
+export {
+  IFeature,
+  ISpatialReference,
+  IHasZM,
+  GeometryType,
+  IField,
+  IFeatureSet,
+  Units,
+  IExtent,
+  SpatialRelationship,
+  IGeometry,
+  ILayerDefinition
+} from "@esri/arcgis-rest-types";

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

@@ -0,0 +1,203 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+
+import {
+  ISpatialReference,
+  IFeatureSet,
+  IFeature,
+  Units,
+  IExtent
+} from "@esri/arcgis-rest-types";
+
+import { IGetLayerOptions, ISharedQueryOptions } from "./helpers";
+
+/**
+ * Request options to fetch a feature by id.
+ */
+export interface IGetFeatureOptions extends IGetLayerOptions {
+  /**
+   * 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 IQueryFeaturesOptions extends ISharedQueryOptions {
+  objectIds?: number[];
+  relationParam?: string;
+  // NOTE: either time=1199145600000 or time=1199145600000, 1230768000000
+  time?: number | number[];
+  distance?: number;
+  units?: Units;
+  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[];
+}
+
+/**
+ * ```js
+ * import { getFeature } from '@esri/arcgis-rest-feature-layer';
+ * //
+ * 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
+ * });
+ * ```
+ * Get a feature by id.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the feature or the [response](https://developer.mozilla.org/en-US/docs/Web/API/Response) itself if `rawResponse: true` was passed in.
+ */
+export function getFeature(
+  requestOptions: IGetFeatureOptions
+): Promise<IFeature> {
+  const url = `${cleanUrl(requestOptions.url)}/${requestOptions.id}`;
+
+  // default to a GET request
+  const options: IGetFeatureOptions = {
+    ...{ httpMethod: "GET" },
+    ...requestOptions
+  };
+  return request(url, options).then((response: any) => {
+    if (options.rawResponse) {
+      return response;
+    }
+    return response.feature;
+  });
+}
+
+/**
+ * ```js
+ * import { queryFeatures } from '@esri/arcgis-rest-feature-layer';
+ * //
+ * queryFeatures({
+ *   url: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3",
+ *   where: "STATE_NAME = 'Alaska'"
+ * })
+ *   .then(result)
+ * ```
+ * Query a feature service. See [REST Documentation](https://developers.arcgis.com/rest/services-reference/query-feature-service-layer-.htm) for more information.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the query response.
+ */
+export function queryFeatures(
+  requestOptions: IQueryFeaturesOptions
+): Promise<IQueryFeaturesResponse | IQueryResponse> {
+  const queryOptions = appendCustomParams<IQueryFeaturesOptions>(
+    requestOptions,
+    [
+      "where",
+      "objectIds",
+      "relationParam",
+      "time",
+      "distance",
+      "units",
+      "outFields",
+      "returnGeometry",
+      "maxAllowableOffset",
+      "geometryPrecision",
+      "outSR",
+      "gdbVersion",
+      "returnDistinctValues",
+      "returnIdsOnly",
+      "returnCountOnly",
+      "returnExtentOnly",
+      "orderByFields",
+      "groupByFieldsForStatistics",
+      "outStatistics",
+      "returnZ",
+      "returnM",
+      "multipatchOption",
+      "resultOffset",
+      "resultRecordCount",
+      "quantizationParameters",
+      "returnCentroid",
+      "resultType",
+      "historicMoment",
+      "returnTrueCurves",
+      "sqlFormat",
+      "returnExceededLimitFeatures"
+    ],
+    {
+      httpMethod: "GET",
+      params: {
+        // set default query parameters
+        where: "1=1",
+        outFields: "*",
+        ...requestOptions.params
+      }
+    }
+  );
+
+  return request(`${cleanUrl(requestOptions.url)}/query`, queryOptions);
+}

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

@@ -0,0 +1,89 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+
+import {
+  ISpatialReference,
+  IFeature,
+  IHasZM,
+  GeometryType,
+  IField
+} from "@esri/arcgis-rest-types";
+
+import { IGetLayerOptions } from "./helpers";
+
+/**
+ * Related record query request options. Additional arguments can be passed via the [params](/arcgis-rest-js/api/feature-service/IQueryRelatedOptions/#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 IQueryRelatedOptions extends IGetLayerOptions {
+  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?: GeometryType;
+  spatialReference?: ISpatialReference;
+  fields?: IField[];
+  relatedRecordGroups: IRelatedRecordGroup[];
+}
+/**
+ *
+ * ```js
+ * import { queryRelated } from '@esri/arcgis-rest-feature-layer'
+ * //
+ * queryRelated({
+ *  url: "http://services.myserver/OrgID/ArcGIS/rest/services/Petroleum/KSPetro/FeatureServer/0",
+ *  relationshipId: 1,
+ *  params: { returnCountOnly: true }
+ * })
+ *  .then(response) // response.relatedRecords
+ * ```
+ * 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.
+ *
+ * @param requestOptions
+ * @returns A Promise that will resolve with the query response
+ */
+export function queryRelated(
+  requestOptions: IQueryRelatedOptions
+): Promise<IQueryRelatedResponse> {
+  const options = appendCustomParams<IQueryRelatedOptions>(
+    requestOptions,
+    ["objectIds", "relationshipId", "definitionExpression", "outFields"],
+    {
+      httpMethod: "GET",
+      params: {
+        // set default query parameters
+        definitionExpression: "1=1",
+        outFields: "*",
+        relationshipId: 0,
+        ...requestOptions.params
+      }
+    }
+  );
+
+  return request(
+    `${cleanUrl(requestOptions.url)}/queryRelatedRecords`,
+    options
+  );
+}

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

@@ -0,0 +1,56 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+
+import { IFeature } from "@esri/arcgis-rest-types";
+
+import { ISharedEditOptions, IEditFeatureResult } from "./helpers";
+
+/**
+ * Update features request options. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/update-features.htm) for more information.
+ *
+ */
+export interface IUpdateFeaturesOptions extends ISharedEditOptions {
+  /**
+   * Array of JSON features to update.
+   */
+  features: IFeature[];
+}
+
+/**
+ *
+ * ```js
+ * import { updateFeatures } from '@esri/arcgis-rest-feature-layer';
+ * //
+ * updateFeatures({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   features: [{
+ *     geometry: { x: -120, y: 45, spatialReference: { wkid: 4326 } },
+ *     attributes: { status: "alive" }
+ *   }]
+ * });
+ * ```
+ * Update features request. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/update-features.htm) for more information.
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the updateFeatures response.
+ */
+export function updateFeatures(
+  requestOptions: IUpdateFeaturesOptions
+): Promise<{ updateResults: IEditFeatureResult[] }> {
+  const url = `${cleanUrl(requestOptions.url)}/updateFeatures`;
+
+  // edit operations are POST only
+  const options = appendCustomParams<IUpdateFeaturesOptions>(
+    requestOptions,
+    ["features", "gdbVersion", "returnEditMoment", "rollbackOnFailure"],
+    { params: { ...requestOptions.params } }
+  );
+
+  return request(url, options);
+}

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
+  );
+}