design methods for feature service attachments

What do you think about this @jgravois and @tomwayson?

A single attachments() method with operation param for the 6 attachment ops and corresponding interfaces for the request params. Down and dirty example below obviously needs much, but for a conceptual start. Just an idea I had while thinking about possibly tackling attachments.

import { request, IRequestOptions } from "@esri/arcgis-rest-request";

export interface IAddAttachmentParameters extends IRequestOptions {
  /**
   * Attachment file.
   */
    attachment: File;
    // other add attachment params
}

// parameter interfaces for the other attachment operations

export interface IAttachmentsOptions {
  /**
   * Feature service url.
   */
  url: string;
  /**
   * Attachment operation to perform.
   */
  operation: "query" | "get" | "infos" | "add" | "delete" | "update";
  /**
   * Attachment parameters for corresponding operation.
   */
  params: IAddAttachmentParameters; // and othersParams
}

export function attachments(
  options: IAttachmentsOptions
): Promise<any> {
  // need to construct proper url based attachment operation and possibly params for some operations
  const url = `${options.url}/addAttachment`;

  const requestParams = options.params;

  return request(url, requestParams);
}

[jgravois]

i think a terse, multi-operation supporting method could actually work quite well for attachments.

take a look at #214 though. we ended up updating the signatures for feature service methods to steer away from defining custom params and extend IRequestOptions consistently instead.

[COV-GIS]

Thanks for the input. The single method idea came to me b/c I’m currently using a single attachment endpoint and request now for attachments. Perhaps a bit over simplified.

If you’re amicable, I’ll make a start as time allows, and ding you for thoughts and comments on my branch.