autnam 1.0.0

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

@@ -0,0 +1,62 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams
+} from "@esri/arcgis-rest-request";
+
+import {
+  ISharedEditOptions,
+  IEditFeatureResult,
+  ISharedQueryOptions
+} from "./helpers.js";
+
+/**
+ * Delete features request options. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/delete-features.htm) for more information.
+ *
+ */
+export interface IDeleteFeaturesOptions
+  extends ISharedEditOptions,
+    ISharedQueryOptions {
+  /**
+   * Array of objectIds to delete.
+   */
+  objectIds: number[];
+}
+
+/**
+ * ```js
+ * import { deleteFeatures } from '@esri/arcgis-rest-feature-service';
+ * //
+ * deleteFeatures({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   objectIds: [1,2,3]
+ * });
+ * ```
+ * Delete features request. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/delete-features.htm) for more information.
+ *
+ * @param deleteFeaturesRequestOptions - Options for the request.
+ * @returns A Promise that will resolve with the deleteFeatures response.
+ */
+export function deleteFeatures(
+  requestOptions: IDeleteFeaturesOptions
+): Promise<{ deleteResults: IEditFeatureResult[] }> {
+  const url = `${cleanUrl(requestOptions.url)}/deleteFeatures`;
+
+  // edit operations POST only
+  const options = appendCustomParams<IDeleteFeaturesOptions>(
+    requestOptions,
+    [
+      "where",
+      "objectIds",
+      "gdbVersion",
+      "returnEditMoment",
+      "rollbackOnFailure"
+    ],
+    { params: { ...requestOptions.params } }
+  );
+
+  return request(url, options);
+}

package/packages/arcgis-rest-feature-service/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.js";
+
+/**
+ * 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-service';
+ * //
+ * 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-service/src/getAllLayersAndTables.ts

@@ -0,0 +1,30 @@
+import { request} from "@esri/arcgis-rest-request";
+import { IGetLayerOptions, parseServiceUrl , ILayerDefinition} from "./helpers.js";
+
+export interface IAllLayersAndTablesResponse {
+  layers: ILayerDefinition[];
+  tables: ILayerDefinition[];
+}
+
+/**
+ * ```js
+ * import { getAllLayersAndTables } from '@esri/arcgis-rest-feature-service';
+ * getAllLayersAndTables({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0"
+ * })
+ *   .then(response) // { layers: [...], tables: [...] }
+ * ```
+ * Fetches all the layers and tables associated with a given layer service.
+ * Wrapper for https://developers.arcgis.com/rest/services-reference/all-layers-and-tables.htm
+ *
+ * @param options - Request options, including the url for the layer service
+ * @returns A Promise that will resolve with the layers and tables for the given service
+ */
+// TODO: should we expand this to support other valid params of the endpoint?
+export function getAllLayersAndTables(
+  options: IGetLayerOptions
+): Promise<IAllLayersAndTablesResponse> {
+  const { url, ...requestOptions } = options;
+  const layersUrl = `${parseServiceUrl(url)}/layers`;
+  return request(layersUrl, requestOptions);
+}

package/packages/arcgis-rest-feature-service/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.js";
+
+/**
+ * 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-service';
+ * //
+ * 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-service/src/getLayer.ts

@@ -0,0 +1,23 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, cleanUrl } from "@esri/arcgis-rest-request";
+import { IGetLayerOptions, ILayerDefinition } from "./helpers.js";
+
+/**
+ * ```js
+ * import { getLayer } from '@esri/arcgis-rest-feature-service';
+ * //
+ * 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-service/src/getService.ts

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

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

@@ -0,0 +1,33 @@
+/* Copyright (c) 2018-2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, ArcGISIdentityManager } from "@esri/arcgis-rest-request";
+import { IServiceInfo } from "./helpers.js";
+
+/**
+ * Given a Feature Service url, fetch the service admin information.
+ *
+ * The response from this call includes all the detailed information
+ * for each layer/table in the service as well as some admin properties
+ *
+ * @export
+ * @param {string} serviceUrl
+ * @param {ArcGISIdentityManager} session
+ * @return {*}  {Promise<IServiceInfo>}
+ */
+export function getServiceAdminInfo(
+  serviceUrl: string,
+  session: ArcGISIdentityManager
+): Promise<IServiceInfo> {
+  const serviceAdminUrl = serviceUrl.replace(
+    "/rest/services",
+    "/rest/admin/services"
+  );
+
+  return request(serviceAdminUrl, {
+    authentication: session,
+    params: {
+      f: "json"
+    }
+  });
+}

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

@@ -0,0 +1,19 @@
+/* Copyright (c) 2018-2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, ArcGISIdentityManager } from "@esri/arcgis-rest-request";
+import { IViewServiceSources } from "./helpers.js";
+
+/**
+ * Return the sources response for a view service item
+ *
+ * @param {string} viewServiceUrl
+ * @param {ArcGISIdentityManager} session
+ * @return {*}  {Promise<Record<string, unknown>>}
+ */
+export function getViewSources(
+  viewServiceUrl: string,
+  session: ArcGISIdentityManager
+): Promise<IViewServiceSources> {
+  return request(`${viewServiceUrl}/sources`, { authentication: session });
+}