autnam 1.0.0

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

@@ -0,0 +1,70 @@
+{
+  "name": "@esri/arcgis-rest-feature-service",
+  "version": "1.0.0-beta.1",
+  "description": "Feature layer query and edit helpers for @esri/arcgis-rest-js",
+  "license": "Apache-2.0",
+  "keywords": [
+    "ES6",
+    "arcgis",
+    "esri",
+    "fetch",
+    "promise",
+    "typescript"
+  ],
+  "type": "module",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "unpkg": "dist/bundled/feature-layer.umd.min.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "types": "dist/esm/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist/**"
+  ],
+  "scripts": {
+    "build": "npm-run-all --parallel build:*",
+    "postbuild": "node ../../scripts/create-dist-package-jsons.js",
+    "build:bundled": "rollup -c ../../rollup.js",
+    "build:cjs": "tsc --outDir ./dist/cjs -m commonjs",
+    "build:esm": "tsc --outDir ./dist/esm --declaration",
+    "dev": "npm-run-all --parallel dev:*",
+    "dev:bundled": "rollup -w -c ../../rollup.js",
+    "dev:cjs": "tsc -w --outDir ./dist/cjs -m commonjs",
+    "dev:esm": "tsc -w --outDir ./dist/esm --declaration"
+  },
+  "engines": {
+    "node": ">=12.20.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-portal": "1.0.0-beta.1",
+    "@esri/arcgis-rest-request": "1.0.0-beta.1"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-portal": "1.0.0-beta.1",
+    "@esri/arcgis-rest-request": "1.0.0-beta.1"
+  },
+  "contributors": [
+    "Mike Tschudi <mtschudi@esri.com>",
+    "Tom Wayson <twayson@esri.com> (http://tomwayson.com/)"
+  ],
+  "homepage": "https://github.com/Esri/arcgis-rest-js#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Esri/arcgis-rest-js.git",
+    "directory": "packages/arcgis-rest-feature-service"
+  },
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

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

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

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

@@ -0,0 +1,53 @@
+/* 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 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 IGetLayerOptions {
+  /**
+   * Unique identifier of feature to add related attachment.
+   */
+  featureId: number;
+  /**
+   * File to be attached.
+   */
+  attachment: File;
+}
+
+/**
+ * ```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]
+ * })
+ *   .then(response)
+ * ```
+ * Attach a file to a feature by id. See [Add Attachment](https://developers.arcgis.com/rest/services-reference/add-attachment.htm) for more information.
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the `addAttachment()` response.
+ */
+export function addAttachment(
+  requestOptions: IAddAttachmentOptions
+): Promise<{ addAttachmentResult: IEditFeatureResult }> {
+  const options: IAddAttachmentOptions = {
+    params: {},
+    ...requestOptions
+  };
+
+  // `attachment` --> params: {}
+  options.params.attachment = requestOptions.attachment;
+
+  return request(
+    `${cleanUrl(options.url)}/${options.featureId}/addAttachment`,
+    options
+  );
+}

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

@@ -0,0 +1,74 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  IUserRequestOptions,
+} from "@esri/arcgis-rest-request";
+
+import { ILayer, ITable, ILayerDefinition } from "./helpers.js";
+
+export interface IAddToServiceDefinitionOptions extends IUserRequestOptions {
+  /**
+   * Layers to add
+   */
+  layers?: ILayer[] | ILayerDefinition[];
+  /**
+   * Tables to add
+   */
+  tables?: ITable[];
+}
+
+export interface IAddToServiceDefinitionItemSummary {
+  name: string;
+  id: any;
+}
+
+export interface IAddToServiceDefinitionResult {
+  layers?: IAddToServiceDefinitionItemSummary[];
+  tables?: IAddToServiceDefinitionItemSummary[];
+  success: boolean;
+}
+
+/**
+ * ```js
+ * import { addToServiceDefinition } from '@esri/arcgis-rest-service-admin';
+ * //
+ * addToServiceDefinition(serviceurl, {
+ *   authentication: ArcGISIdentityManager,
+ *   layers: [],
+ *   tables: []
+ * });
+ * ```
+ * Add layer(s) and/or table(s) to a hosted feature service. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/add-to-definition-feature-service-.htm) for more information.
+ *
+ * @param url - URL of feature service
+ * @param requestOptions - Options for the request
+ * @returns A Promise that resolves with service layer and/or table details once the definition
+ * has been updated
+ */
+export function addToServiceDefinition(
+  url: string,
+  requestOptions: IAddToServiceDefinitionOptions
+): Promise<IAddToServiceDefinitionResult> {
+  const adminUrl = `${cleanUrl(url).replace(
+    `/rest/services`,
+    `/rest/admin/services`
+  )}/addToDefinition`;
+
+  requestOptions.params = {
+    addToDefinition: {},
+    ...requestOptions.params
+  };
+
+  if (requestOptions.layers && requestOptions.layers.length > 0) {
+    requestOptions.params.addToDefinition.layers = requestOptions.layers;
+  }
+
+  if (requestOptions.tables && requestOptions.tables.length > 0) {
+    requestOptions.params.addToDefinition.tables = requestOptions.tables;
+  }
+
+  return request(adminUrl, requestOptions);
+}

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

@@ -0,0 +1,94 @@
+/* Copyright (c) 2017-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  cleanUrl,
+  appendCustomParams,
+  IFeature
+} from "@esri/arcgis-rest-request";
+
+import { ISharedEditOptions, IApplyEditsResult } from "./helpers.js";
+
+/**
+ * Apply edits request options. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/apply-edits-feature-service-layer-.htm) for more information.
+ *
+ */
+export interface IApplyEditsOptions extends ISharedEditOptions {
+  /**
+   * Array of JSON features to add.
+   */
+  adds?: IFeature[];
+  /**
+   * Array of JSON features to update.
+   */
+  updates?: IFeature[];
+  /**
+   * Array of objectIds or globalIds to delete.
+   */
+  deletes?: number[] | string[];
+  /**
+   * When set to true, the features and attachments in the adds, updates, deletes, and attachments parameters are identified by their globalIds.
+   */
+  useGlobalIds?: boolean;
+  /**
+   * Optional parameter which is false by default is set by client to indicate to the server that client in true curve capable.
+   */
+  trueCurveClient?: boolean;
+  /**
+   * Use the attachments parameter to add, update or delete attachments. Applies only when the useGlobalIds parameter is set to true.
+   * See [attachment](https://developers.arcgis.com/rest/services-reference/apply-edits-feature-service-layer-.htm) param details.
+   */
+  attachments?: {
+    adds?: any[];
+    updates?: any[];
+    deletes?: string[];
+  };
+}
+
+/**
+ * ```js
+ * import { applyEdits } from '@esri/arcgis-rest-feature-service';
+ * //
+ * applyEdits({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   adds: [{
+ *     geometry: { x: -120, y: 45, spatialReference: { wkid: 4326 } },
+ *     attributes: { status: "alive" }
+ *   }],
+ *   updates: [{
+ *     attributes: { OBJECTID: 1004, status: "alive" }
+ *   }],
+ *   deletes: [862, 1548]
+ * })
+ *   .then(response)
+ * ```
+ * Apply edits request. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/apply-edits-feature-service-layer-.htm) for more information.
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the applyEdits response.
+ */
+export function applyEdits(
+  requestOptions: IApplyEditsOptions
+): Promise<IApplyEditsResult> {
+  const url = `${cleanUrl(requestOptions.url)}/applyEdits`;
+
+  // edit operations are POST only
+  const options = appendCustomParams<IApplyEditsOptions>(
+    requestOptions,
+    [
+      "adds",
+      "updates",
+      "deletes",
+      "useGlobalIds",
+      "attachments",
+      "gdbVersion",
+      "returnEditMoment",
+      "rollbackOnFailure",
+      "trueCurveClient"
+    ],
+    { params: { ...requestOptions.params } }
+  );
+
+  return request(url, options);
+}

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

@@ -0,0 +1,191 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, IExtent, ISpatialReference } from "@esri/arcgis-rest-request";
+
+import {
+  moveItem,
+  ICreateUpdateItemOptions,
+  determineOwner,
+  getPortalUrl
+} from "@esri/arcgis-rest-portal";
+
+/**
+ * A [`createParameters` JSON object for a new
+ * service](https://developers.arcgis.com/rest/users-groups-and-items/create-service.htm).
+ */
+export interface ICreateServiceParams {
+  /**
+   * Name of the service to be created. This name must be unique. If the name already exists, the operation will fail. ArcGIS Enterprise does not allow spaces or special characters other than underscores in a service name.
+   */
+  name: string;
+  /**
+   * Description given to the service.
+   */
+  serviceDescription?: string;
+  /**
+   * Indicates whether the data changes.
+   */
+  hasStaticData?: boolean;
+  /**
+   * A double value indicating any constraints enforced on query operations.
+   */
+  maxRecordCount?: number;
+  /**
+   * The formats in which query results are returned.
+   */
+  supportedQueryFormats?: string;
+  /**
+   * Specify feature service editing capabilities for Create, Delete, Query, Update, and Sync.
+   */
+  capabilities?: string;
+  /**
+   * A user-friendly description for the published dataset.
+   */
+  description?: string;
+  /**
+   * Copyright information associated with the dataset.
+   */
+  copyrightText?: string;
+  /**
+   * All layers added to a hosted feature service need to have the same spatial reference defined for
+   * the feature service. When creating a new empty service without specifying its spatial reference,
+   * the spatial reference of the hosted feature service is set to the first layer added to that
+   * feature service.
+   */
+  spatialReference?: ISpatialReference;
+  /**
+   * The initial extent set for the service.
+   */
+  initialExtent?: IExtent;
+  /**
+   * Indicates if updating the geometry of the service is permitted.
+   */
+  allowGeometryUpdates?: boolean;
+  /**
+   * Units used by the feature service
+   */
+  units?: string;
+  /**
+   * A JSON object specifying the properties of cross-site scripting prevention.
+   */
+  xssPreventionInfo?: any;
+  /**
+   * Editor tracking info.
+   */
+  editorTrackingInfo?: {
+    enableEditorTracking?: boolean;
+    enableOwnershipAccessControl?: boolean;
+    allowOthersToUpdate?: boolean;
+    allowOthersToDelete?: boolean;
+    allowOthersToQuery?: boolean;
+    allowAnonymousToUpdate?: boolean;
+    allowAnonymousToDelete?: boolean;
+  };
+}
+
+export interface ICreateServiceOptions extends ICreateUpdateItemOptions {
+  /**
+   * A JSON object specifying the properties of the newly-created service. See the [REST
+   * Documentation](https://developers.arcgis.com/rest/users-groups-and-items/working-with-users-groups-and-items.htm)
+   * for more information.
+   */
+  item: ICreateServiceParams;
+  /**
+   * Alphanumeric id of folder to house moved item. If null, empty, or "/", the destination is the
+   * root folder.
+   */
+  folderId?: string;
+}
+
+export interface ICreateServiceResult {
+  /**
+   * The encoded URL to the hosted service.
+   */
+  encodedServiceURL: string;
+
+  /**
+   * Indicates if this feature service represents a view.
+   */
+  isView: boolean;
+
+  /**
+   * The unique ID for this item.
+   */
+  itemId: string;
+
+  /**
+   * Name of the service item.
+   */
+  name: string;
+
+  /**
+   * The ID of the new service item.
+   */
+  serviceItemId: string;
+
+  /**
+   * The URL to the hosted service.
+   */
+  serviceurl: string;
+
+  /**
+   * The size of the item.
+   */
+  size: number;
+
+  /**
+   * Indicates if the operation was successful.
+   */
+  success: boolean;
+
+  /**
+   * The type of service created.
+   */
+  type: string;
+}
+
+/**
+ * ```js
+ * import {
+ *   createFeatureService,
+ *   addToServiceDefinition
+ * } from '@esri/arcgis-rest-service-admin';
+ * //
+ * createFeatureService({
+ *   authentication: ArcGISIdentityManager,
+ *   item: {
+ *     "name": "NewEmptyService",
+ *     "capabilities": "Create,Delete,Query,Update,Editing"
+ *   }
+ * });
+ * ```
+ * Create a new [hosted feature service](https://developers.arcgis.com/rest/users-groups-and-items/create-service.htm). After the service has been created, call [`addToServiceDefinition()`](../addToServiceDefinition/) if you'd like to update it's schema.
+ * @param requestOptions - Options for the request. NOTE: `rawResponse` is not supported by this operation.
+ * @returns A Promise that resolves with service details once the service has been created
+ */
+export function createFeatureService(
+  requestOptions: ICreateServiceOptions
+): Promise<ICreateServiceResult> {
+  return determineOwner(requestOptions).then((owner) => {
+    const options: ICreateServiceOptions = {
+      ...requestOptions,
+      rawResponse: false
+    };
+    const baseUrl = `${getPortalUrl(requestOptions)}/content/users/${owner}`;
+    const folder =
+      !options.folderId || options.folderId === "/"
+        ? ""
+        : "/" + options.folderId;
+    const url = `${baseUrl}${folder}/createService`;
+
+    // Create the service
+    options.params = {
+      createParameters: options.item,
+      outputType: "featureService",
+      ...options.params
+    };
+
+    return request(url, options);
+  });
+}

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

@@ -0,0 +1,126 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  IRequestOptions,
+  IField,
+  IFeature
+} from "@esri/arcgis-rest-request";
+
+import { IQueryFeaturesResponse } from "./query.js";
+import { getLayer } from "./getLayer.js";
+import { ILayerDefinition } from "./helpers.js";
+
+/**
+ * Request options to fetch a feature by id.
+ */
+export interface IDecodeValuesOptions 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[];
+}
+
+/**
+ * ```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)
+ *   })
+ * ```
+ * Replaces the raw coded domain values in a query response with descriptions (for legibility).
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the addFeatures response.
+ */
+export function decodeValues(
+  requestOptions: IDecodeValuesOptions
+): Promise<IQueryFeaturesResponse> {
+  let prms;
+  if (requestOptions.fields) {
+    prms = Promise.resolve(requestOptions.fields);
+  } else {
+    prms = getLayer({ url: requestOptions.url }).then(
+      (metadata: ILayerDefinition) => {
+        return metadata.fields;
+      }
+    );
+  }
+  return prms.then((fields) => {
+    // extract coded value domains
+    const domains = extractCodedValueDomains(fields);
+    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 (!Object.prototype.hasOwnProperty.call(feature.attributes, 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;
+}