aspernaturalias 1.0.0

package/packages/arcgis-rest-portal/src/groups/protect.ts

@@ -0,0 +1,56 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request } from "@esri/arcgis-rest-request";
+
+import { getPortalUrl } from "../util/get-portal-url";
+import { IUserGroupOptions } from "./helpers";
+
+/**
+ * ```js
+ * import { protectGroup } from '@esri/arcgis-rest-portal';
+ * //
+ * protectGroup({
+ *   id: groupId,
+ *   authentication
+ * })
+ *   .then(response)
+ * ```
+ * Protect a group to avoid accidental deletion. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/protect-group.htm) for more information.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+export function protectGroup(
+  requestOptions: IUserGroupOptions
+): Promise<{ success: boolean }> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${
+    requestOptions.id
+  }/protect`;
+
+  return request(url, requestOptions);
+}
+
+/**
+ * ```js
+ * import { unprotectGroup } from '@esri/arcgis-rest-portal';
+ * //
+ * unprotectGroup({
+ *   id: groupId,
+ *   authentication
+ * })
+ *   .then(response)
+ * ```
+ * Unprotect a Group. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/unprotect-group.htm) for more information.
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+export function unprotectGroup(
+  requestOptions: IUserGroupOptions
+): Promise<{ success: boolean }> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${
+    requestOptions.id
+  }/unprotect`;
+
+  return request(url, requestOptions);
+}

package/packages/arcgis-rest-portal/src/groups/remove.ts

@@ -0,0 +1,32 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request } from "@esri/arcgis-rest-request";
+
+import { getPortalUrl } from "../util/get-portal-url";
+import { IUserGroupOptions } from "./helpers";
+
+/**
+ * ```js
+ * import { removeGroup } from '@esri/arcgis-rest-portal';
+ * //
+ * removeGroup({
+ *   id: groupId,
+ *   authentication
+ * })
+ *   .then(response)
+ * ```
+ * Delete a group. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/delete-group.htm) for more information.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+export function removeGroup(requestOptions: IUserGroupOptions): Promise<any> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${
+    requestOptions.id
+  }/delete`;
+  const options: IUserGroupOptions = {
+    ...requestOptions
+  };
+  return request(url, options);
+}

package/packages/arcgis-rest-portal/src/groups/search.ts

@@ -0,0 +1,25 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IGroup } from "@esri/arcgis-rest-types";
+import { SearchQueryBuilder } from "../util/SearchQueryBuilder";
+import { ISearchOptions, ISearchResult } from "../util/search";
+import { genericSearch } from "../util/generic-search";
+
+/**
+ * ```js
+ * import { searchGroups } from "@esri/arcgis-rest-portal";
+ * //
+ * searchGroups('water')
+ *   .then(response) // response.total => 355
+ * ```
+ * Search a portal for groups. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/group-search.htm) for more information.
+ *
+ * @param search - A string or RequestOptions object to pass through to the endpoint.
+ * @returns A Promise that will resolve with the data from the response.
+ */
+export function searchGroups(
+  search: string | ISearchOptions | SearchQueryBuilder
+): Promise<ISearchResult<IGroup>> {
+  return genericSearch<IGroup>(search, "group");
+}

package/packages/arcgis-rest-portal/src/groups/update.ts

@@ -0,0 +1,39 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
+import { IItemUpdate } from "@esri/arcgis-rest-types";
+import { getPortalUrl } from "../util/get-portal-url";
+
+export interface IUpdateGroupOptions extends IRequestOptions {
+  group: IItemUpdate;
+}
+
+/**
+ * ```js
+ * import { updateGroup } from '@esri/arcgis-rest-portal';
+ * //
+ * updateGroup({
+ *   group: { id: "fgr344", title: "new" }
+ * })
+ *   .then(response)
+ * ```
+ * Update the properties of a group. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/update-group.htm) for more information.
+ *
+ * @param requestOptions - Options for the request, including the group
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+export function updateGroup(
+  requestOptions: IUpdateGroupOptions
+): Promise<{ success: boolean; groupId: string }> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${
+    requestOptions.group.id
+  }/update`;
+
+  requestOptions.params = {
+    ...requestOptions.params,
+    ...requestOptions.group
+  };
+
+  return request(url, requestOptions);
+}

package/packages/arcgis-rest-portal/src/index.ts

@@ -0,0 +1,48 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export * from "./items/add";
+export * from "./items/create";
+export * from "./items/get";
+export * from "./items/protect";
+export * from "./items/remove";
+export * from "./items/search";
+export * from "./items/update";
+export * from "./items/helpers";
+
+export * from "./groups/create";
+export * from "./groups/get";
+export * from "./groups/helpers";
+export * from "./groups/notification";
+export * from "./groups/protect";
+export * from "./groups/remove";
+export * from "./groups/search";
+export * from "./groups/update";
+export * from "./groups/join";
+
+export * from "./users/get-user";
+export * from "./users/get-user-url";
+export * from "./users/invitation";
+export * from "./users/notification";
+export * from "./users/update";
+
+export * from "./sharing/access";
+export * from "./sharing/group-sharing";
+export * from "./sharing/helpers";
+
+export * from "./util/get-portal";
+export * from "./util/get-portal-url";
+export * from "./util/search";
+export * from "./util/SearchQueryBuilder";
+// we dont export 'generic-search' because its an internal utility method
+// export * from "./util/generic-search"; because its an internal utility method
+export {
+  IPagingParams,
+  IUser,
+  IItemAdd,
+  IItemUpdate,
+  IItem,
+  IGroupAdd,
+  IGroup,
+  GroupMembership
+} from "@esri/arcgis-rest-types";

package/packages/arcgis-rest-portal/src/items/add.ts

@@ -0,0 +1,137 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, appendCustomParams } from "@esri/arcgis-rest-request";
+
+import { getPortalUrl } from "../util/get-portal-url";
+import {
+  IUserItemOptions,
+  IItemResourceOptions,
+  IUpdateItemResponse,
+  IItemResourceResponse,
+  determineOwner,
+  IManageItemRelationshipOptions
+} from "./helpers";
+import { updateItem, IUpdateItemOptions } from "./update";
+
+export interface IAddItemDataOptions extends IUserItemOptions {
+  /**
+   * Object to store
+   */
+  data: any;
+}
+
+/**
+ * ```js
+ * import { addItemData } from "@esri/arcgis-rest-portal";
+ * //
+ * addItemData({
+ *   id: '3ef',
+ *   data: file,
+ *   authentication
+ * })
+ *   .then(response)
+ * ```
+ * Send a file or blob to an item to be stored as the `/data` resource. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/update-item.htm) for more information.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with an object reporting
+ *        success/failure and echoing the item id.
+ */
+export function addItemData(
+  requestOptions: IAddItemDataOptions
+): Promise<IUpdateItemResponse> {
+  const owner = determineOwner(requestOptions);
+  const options: any = {
+    item: {
+      id: requestOptions.id,
+      data: requestOptions.data
+    },
+    ...requestOptions
+  };
+
+  delete options.id;
+  delete options.data;
+
+  return updateItem(options as IUpdateItemOptions);
+}
+
+/**
+ * ```js
+ * import { addItemRelationship } from "@esri/arcgis-rest-portal";
+ * //
+ * addItemRelationship({
+ *   originItemId: '3ef',
+ *   destinationItemId: 'ae7',
+ *   relationshipType: 'Service2Layer',
+ *   authentication
+ * })
+ *   .then(response)
+ * ```
+ * Add a relationship between two items. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/add-relationship.htm) for more information.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise to add item resources.
+ */
+export function addItemRelationship(
+  requestOptions: IManageItemRelationshipOptions
+): Promise<{ success: boolean }> {
+  const owner = determineOwner(requestOptions);
+  const url = `${getPortalUrl(
+    requestOptions
+  )}/content/users/${owner}/addRelationship`;
+
+  const options = appendCustomParams<IManageItemRelationshipOptions>(
+    requestOptions,
+    ["originItemId", "destinationItemId", "relationshipType"],
+    { params: { ...requestOptions.params } }
+  );
+
+  return request(url, options);
+}
+
+/**
+ * ```js
+ * import { addItemResource } from "@esri/arcgis-rest-portal";
+ *
+ * // Add a file resource
+ * addItemResource({
+ *   id: '3ef',
+ *   resource: file,
+ *   name: 'bigkahuna.jpg',
+ *   authentication
+ * })
+ *   .then(response)
+ *
+ * // Add a text resource
+ * addItemResource({
+ *   id: '4fg',
+ *   content: "Text content",
+ *   name: 'bigkahuna.txt',
+ *   authentication
+ * })
+ *   .then(response)
+ * ```
+ * Add a resource associated with an item. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/add-resources.htm) for more information.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise to add item resources.
+ */
+export function addItemResource(
+  requestOptions: IItemResourceOptions
+): Promise<IItemResourceResponse> {
+  const owner = determineOwner(requestOptions);
+  const url = `${getPortalUrl(requestOptions)}/content/users/${owner}/items/${
+    requestOptions.id
+  }/addResources`;
+
+  requestOptions.params = {
+    file: requestOptions.resource,
+    fileName: requestOptions.name,
+    text: requestOptions.content,
+    access: requestOptions.private ? "private" : "inherit",
+    ...requestOptions.params
+  };
+
+  return request(url, requestOptions);
+}

package/packages/arcgis-rest-portal/src/items/create.ts

@@ -0,0 +1,128 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request } from "@esri/arcgis-rest-request";
+import { IItemAdd } from "@esri/arcgis-rest-types";
+
+import { getPortalUrl } from "../util/get-portal-url";
+import {
+  IAddFolderResponse,
+  IUpdateItemResponse,
+  ICreateUpdateItemOptions,
+  serializeItem,
+  determineOwner
+} from "./helpers";
+
+export interface ICreateFolderOptions extends ICreateUpdateItemOptions {
+  /**
+   * Name of the folder to create.
+   */
+  title: string;
+}
+
+export interface ICreateItemOptions extends ICreateUpdateItemOptions {
+  item: IItemAdd;
+}
+
+export interface ICreateItemResponse extends IUpdateItemResponse {
+  folder: string;
+}
+
+/**
+ * ```js
+ * import { createFolder } from "@esri/arcgis-rest-portal";
+ * //
+ * createFolder({
+ *   title: 'Map Collection',
+ *   authentication: userSession
+ * })
+ *   .then(response)
+ * ```
+ * Create a folder. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/create-folder.htm) for more information.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that resolves with folder details once the folder has been created
+ */
+export function createFolder(
+  requestOptions: ICreateFolderOptions
+): Promise<IAddFolderResponse> {
+  const owner = determineOwner(requestOptions);
+
+  const baseUrl = `${getPortalUrl(requestOptions)}/content/users/${owner}`;
+  const url = `${baseUrl}/createFolder`;
+
+  requestOptions.params = {
+    title: requestOptions.title,
+    ...requestOptions.params
+  };
+
+  return request(url, requestOptions);
+}
+
+/**
+ * ```js
+ * import { createItemInFolder } from "@esri/arcgis-rest-portal";
+ * //
+ * createItem({
+ *   item: {
+ *     title: "The Amazing Voyage",
+ *     type: "Web Map",
+ *     data: {}
+ *   },
+ *   folderId: 'fe8',
+ *   authentication
+ * })
+ * ```
+ * Create an item in a folder. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/add-item.htm) for more information.
+ *
+ * @param requestOptions = Options for the request
+ */
+export function createItemInFolder(
+  requestOptions: ICreateItemOptions
+): Promise<ICreateItemResponse> {
+  const owner = determineOwner(requestOptions);
+
+  const baseUrl = `${getPortalUrl(requestOptions)}/content/users/${owner}`;
+  let url = `${baseUrl}/addItem`;
+
+  if (requestOptions.folderId) {
+    url = `${baseUrl}/${requestOptions.folderId}/addItem`;
+  }
+
+  // serialize the item into something Portal will accept
+  requestOptions.params = {
+    ...requestOptions.params,
+    ...serializeItem(requestOptions.item)
+  };
+
+  return request(url, requestOptions);
+}
+
+/**
+ * ```js
+ * import { createItem } from "@esri/arcgis-rest-portal";
+ * //
+ * createItem({
+ *   item: {
+ *     title: "The Amazing Voyage",
+ *     type: "Web Map",
+ *     data: {}
+ *   },
+ *   authentication
+ * })
+ * ```
+ * Create an Item in the user's root folder. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/add-item.htm) for more information.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that creates an item.
+ */
+export function createItem(
+  requestOptions: ICreateItemOptions
+): Promise<ICreateItemResponse> {
+  // delegate to createItemInFolder placing in the root of the filestore
+  const options = {
+    folderId: null,
+    ...requestOptions
+  } as ICreateItemOptions;
+  return createItemInFolder(options);
+}

package/packages/arcgis-rest-portal/src/items/get.ts

@@ -0,0 +1,177 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
+import { IItem, IGroup } from "@esri/arcgis-rest-types";
+
+import { getPortalUrl } from "../util/get-portal-url";
+import { IItemDataOptions, IItemRelationshipOptions } from "./helpers";
+
+/**
+ * ```
+ * import { getItem } from "@esri/arcgis-rest-portal";
+ * //
+ * getItem("ae7")
+ *   .then(response);
+ * // or
+ * getItem("ae7", { authentication })
+ *   .then(response)
+ * ```
+ * Get an item by id. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/item.htm) for more information.
+ *
+ * @param id - Item Id
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the data from the response.
+ */
+export function getItem(
+  id: string,
+  requestOptions?: IRequestOptions
+): Promise<IItem> {
+  const url = `${getPortalUrl(requestOptions)}/content/items/${id}`;
+
+  // default to a GET request
+  const options: IRequestOptions = {
+    ...{ httpMethod: "GET" },
+    ...requestOptions
+  };
+  return request(url, options);
+}
+
+/**
+ * ```
+ * import { getItemData } from "@esri/arcgis-rest-portal";
+ * //
+ * getItemData("ae7")
+ *   .then(response)
+ * // or
+ * getItemData("ae7", { authentication })
+ *   .then(response)
+ * ```
+ * Get the /data for an item. If no data exists, returns `undefined`. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/item-data.htm) for more information.
+ * @param id - Item Id
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the json data for the item.
+ */
+export function getItemData(
+  id: string,
+  requestOptions?: IItemDataOptions
+): Promise<any> {
+  const url = `${getPortalUrl(requestOptions)}/content/items/${id}/data`;
+  // default to a GET request
+  const options: IItemDataOptions = {
+    ...{ httpMethod: "GET", params: {} },
+    ...requestOptions
+  };
+
+  if (options.file) {
+    options.params.f = null;
+  }
+
+  return request(url, options).catch(err => {
+    /* if the item doesn't include data, the response will be empty
+       and the internal call to response.json() will fail */
+    const emptyResponseErr = RegExp(
+      /Unexpected end of (JSON input|data at line 1 column 1)/i
+    );
+    /* istanbul ignore else */
+    if (emptyResponseErr.test(err.message)) {
+      return;
+    } else throw err;
+  });
+}
+
+export interface IGetRelatedItemsResponse {
+  total: number;
+  relatedItems: IItem[];
+}
+
+/**
+ * ```
+ * import { getRelatedItems } from "@esri/arcgis-rest-portal";
+ * //
+ * getRelatedItems({
+ *   id: "ae7",
+ *   relationshipType: "Service2Layer" // or several ["Service2Layer", "Map2Area"]
+ * })
+ *   .then(response)
+ * ```
+ * Get the related items. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/related-items.htm) for more information.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise to get some item resources.
+ */
+export function getRelatedItems(
+  requestOptions: IItemRelationshipOptions
+): Promise<IGetRelatedItemsResponse> {
+  const url = `${getPortalUrl(requestOptions)}/content/items/${
+    requestOptions.id
+  }/relatedItems`;
+
+  const options: IItemRelationshipOptions = {
+    httpMethod: "GET",
+    params: {
+      direction: requestOptions.direction
+    },
+    ...requestOptions
+  };
+
+  if (typeof requestOptions.relationshipType === "string") {
+    options.params.relationshipType = requestOptions.relationshipType;
+  } else {
+    options.params.relationshipTypes = requestOptions.relationshipType;
+  }
+
+  delete options.direction;
+  delete options.relationshipType;
+
+  return request(url, options);
+}
+
+/**
+ * Get the resources associated with an item
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise to get some item resources.
+ */
+export function getItemResources(
+  id: string,
+  requestOptions?: IRequestOptions
+): Promise<any> {
+  const url = `${getPortalUrl(requestOptions)}/content/items/${id}/resources`;
+
+  // mix in user supplied params
+  requestOptions.params = {
+    ...requestOptions.params,
+    num: 1000
+  };
+
+  return request(url, requestOptions);
+}
+
+export interface IGetItemGroupsResponse {
+  admin?: IGroup[];
+  member?: IGroup[];
+  other?: IGroup[];
+}
+
+/**
+ * ```js
+ * import { getItemGroups } from "@esri/arcgis-rest-portal";
+ * //
+ * getItemGroups("30e5fe3149c34df1ba922e6f5bbf808f")
+ *   .then(response)
+ * ```
+ * Lists the groups of which the item is a part, only showing the groups that the calling user can access. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/groups.htm) for more information.
+ *
+ * @param id - The Id of the item to query group association for.
+ * @param requestOptions - Options for the request
+ * @returns A Promise to get some item groups.
+ */
+export function getItemGroups(
+  id: string,
+  requestOptions?: IRequestOptions
+): Promise<IGetItemGroupsResponse> {
+  const url = `${getPortalUrl(requestOptions)}/content/items/${id}/groups`;
+
+  return request(url, requestOptions);
+}