culparepellendus 1.0.0

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

@@ -0,0 +1,63 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { getPortalUrl } from "../util/get-portal-url";
+import { request } from "@esri/arcgis-rest-request";
+
+export interface IUpdateGroupUsersResult {
+  /**
+   * Array of results
+   */
+  results: any[];
+}
+
+export interface IUpdateGroupUsersOptions extends IUserRequestOptions {
+  /**
+   * Group ID
+   */
+  id: string;
+  /**
+   * An array of usernames to be updated
+   */
+  users: string[];
+  /**
+   * Membership Type to update to
+   */
+  newMemberType: "member" | "admin";
+}
+
+/**
+ * ```js
+ * import { updateUserMemberships } from "@esri/arcgis-rest-portal";
+ * //
+ * updateUserMemberships({
+ *   id: groupId,
+ *   admins: ["username3"],
+ *   authentication
+ * })
+ * .then(response);
+ * ```
+ * Change the user membership levels of existing users in a group
+ *
+ * @param requestOptions  - Options for the request
+ * @returns A Promise
+ */
+export function updateUserMemberships(
+  requestOptions: IUpdateGroupUsersOptions
+): Promise<IUpdateGroupUsersResult> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${
+    requestOptions.id
+  }/updateUsers`;
+  const opts: any = {
+    authentication: requestOptions.authentication,
+    params: {}
+  };
+  // add the correct params depending on the type of membership we are changing to
+  if (requestOptions.newMemberType === "admin") {
+    opts.params.admins = requestOptions.users;
+  } else {
+    opts.params.users = requestOptions.users;
+  }
+  // make the request
+  return request(url, opts);
+}

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,70 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export * from "./items/add";
+export * from "./items/content";
+export * from "./items/create";
+export * from "./items/export";
+export * from "./items/get";
+export * from "./items/protect";
+export * from "./items/reassign";
+export * from "./items/remove";
+export * from "./items/search";
+export * from "./items/update";
+export * from "./items/helpers";
+export * from "./items/upload";
+
+export * from "./groups/add-users";
+export * from "./groups/remove-users";
+export * from "./groups/invite-users";
+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/update-user-membership";
+export * from "./groups/join";
+
+export * from "./orgs/notification";
+
+export * from "./users/get-user";
+export * from "./users/get-user-tags";
+export * from "./users/get-user-url";
+export * from "./users/invitation";
+export * from "./users/notification";
+export * from "./users/search-users";
+export * from "./users/update";
+
+export * from "./sharing/access";
+export * from "./sharing/share-item-with-group";
+export * from "./sharing/unshare-item-with-group";
+export * from "./sharing/is-item-shared-with-group";
+export * from "./sharing/helpers";
+
+export * from "./services/get-unique-service-name";
+export * from "./services/is-service-name-available";
+
+export * from "./util/get-portal";
+export * from "./util/get-portal-settings";
+export * from "./util/get-portal-url";
+export * from "./util/get-subscription-info";
+export * from "./util/scrub-control-chars";
+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,
+  IPagedResponse,
+  IUser,
+  IItemAdd,
+  IItemUpdate,
+  IItem,
+  IFolder,
+  IGroupAdd,
+  IGroup,
+  GroupMembership,
+} from "@esri/arcgis-rest-types";

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

@@ -0,0 +1,138 @@
+/* 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 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 }> {
+  return determineOwner(requestOptions).then(owner => {
+    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> {
+  return determineOwner(requestOptions).then(owner => {
+    const url = `${getPortalUrl(requestOptions)}/content/users/${owner}/items/${
+      requestOptions.id
+    }/addResources`;
+
+    requestOptions.params = {
+      file: requestOptions.resource,
+      fileName: requestOptions.name,
+      resourcesPrefix: requestOptions.prefix,
+      text: requestOptions.content,
+      access: requestOptions.private ? "private" : "inherit",
+      ...requestOptions.params
+    };
+
+    return request(url, requestOptions);
+  });
+}

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

@@ -0,0 +1,67 @@
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
+import {
+  IPagingParams,
+  IItem,
+  IFolder,
+  IPagedResponse,
+} from "@esri/arcgis-rest-types";
+import { getPortalUrl } from "../util/get-portal-url";
+import { determineOwner } from "./helpers";
+
+export type UnixTime = number;
+
+export interface IUserContentRequestOptions
+  extends IPagingParams,
+    IRequestOptions {
+  owner?: string;
+  folderId?: string;
+}
+
+export interface IUserContentResponse extends IPagedResponse {
+  username: string;
+  currentFolder?: IFolder;
+  items: IItem[];
+  folders: IFolder[];
+}
+
+/**
+ * ```js
+ * import { getUserContent } from "@esri/arcgis-rest-portal";
+ * //
+ * getUserContent({
+ *    owner: 'geemike',
+ *    folderId: 'bao7',
+ *    start: 1,
+ *    num: 20,
+ *    authentication
+ * })
+ * ```
+ * Returns a listing of the user's content. If the `username` is not supplied, it defaults to the username of the authenticated user. If `start` is not specificed it defaults to the first page.
+ * If the `num` is not supplied it is defaulted to 10. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/user-content.htm) for more information.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise<IUserContentResponse>
+ */
+export const getUserContent = (
+  requestOptions: IUserContentRequestOptions
+): Promise<IUserContentResponse> => {
+  const {
+    folderId: folder,
+    start = 1,
+    num = 10,
+    authentication,
+  } = requestOptions;
+  const suffix = folder ? `/${folder}` : "";
+
+  return determineOwner(requestOptions)
+    .then((owner) => `${getPortalUrl(requestOptions)}/content/users/${owner}${suffix}`)
+    .then((url) => request(url, {
+      httpMethod: "GET",
+      authentication,
+      params: {
+        start,
+        num,
+      },
+    })
+  );
+};

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

@@ -0,0 +1,150 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, appendCustomParams } 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> {
+  return determineOwner(requestOptions).then(owner => {
+    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";
+ * //
+ * createItemInFolder({
+ *   item: {
+ *     title: "The Amazing Voyage",
+ *     type: "Web Map"
+ *   },
+ *   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> {
+  if (requestOptions.multipart && !requestOptions.filename) {
+    return Promise.reject(
+      new Error("The filename is required for a multipart request.")
+    );
+  }
+
+  return determineOwner(requestOptions).then(owner => {
+    const baseUrl = `${getPortalUrl(requestOptions)}/content/users/${owner}`;
+    let url = `${baseUrl}/addItem`;
+
+    if (requestOptions.folderId) {
+      url = `${baseUrl}/${requestOptions.folderId}/addItem`;
+    }
+
+    requestOptions.params = {
+      ...requestOptions.params,
+      ...serializeItem(requestOptions.item)
+    };
+
+    // serialize the item into something Portal will accept
+    const options = appendCustomParams<ICreateItemOptions>(
+      requestOptions,
+      [
+        "owner",
+        "folderId",
+        "file",
+        "dataUrl",
+        "text",
+        "async",
+        "multipart",
+        "filename",
+        "overwrite"
+      ],
+      {
+        params: { ...requestOptions.params }
+      }
+    );
+
+    return request(url, options);
+  });
+}
+
+/**
+ * ```js
+ * import { createItem } from "@esri/arcgis-rest-portal";
+ * //
+ * createItem({
+ *   item: {
+ *     title: "The Amazing Voyage",
+ *     type: "Web Map"
+ *   },
+ *   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/export.ts

@@ -0,0 +1,80 @@
+import { request } from "@esri/arcgis-rest-request";
+import { determineOwner, IUserItemOptions } from './helpers';
+import { getPortalUrl } from "../util/get-portal-url";
+import { ISpatialReference } from '@esri/arcgis-rest-types';
+
+type ExportFormat = 'Shapefile' | 'CSV' | 'File Geodatabase' | 'Feature Collection' | 'GeoJson' | 'Scene Package' | 'KML' | 'Excel';
+
+export interface IExportLayerInfo {
+  id: number;
+  where?: string;
+  includeGeometry?: boolean;
+  xColumnName?: string;
+  yColumnName?: string;
+}
+
+export interface IExportParameters {
+  layers?: IExportLayerInfo[];
+  targetSR?: ISpatialReference | string;
+}
+
+export interface IExportItemRequestOptions extends IUserItemOptions {
+  title?: string;
+  exportFormat: ExportFormat;
+  exportParameters?: IExportParameters;
+}
+
+export interface IExportItemResponse {
+  type: string;
+  size: number;
+  jobId: string;
+  exportItemId: string;
+  serviceItemId: string;
+  exportFormat: ExportFormat;
+}
+
+/**
+ * ```js
+ * import { exportItem } from "@esri/arcgis-rest-portal";
+ * //
+ * exportItem({
+ *      id: '3daf',
+ *      owner: 'geemike',
+ *      exportFormat: 'CSV',
+ *      exportParameters: {
+ *        layers: [
+ *          { id: 0 },
+ *          { id: 1, where: 'POP1999 > 100000' }
+ *        ]
+ *      },
+ *      authentication,
+ *    })
+ * ```
+ * Exports an item from the portal. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/export-item.htm) for more information.
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise<IExportItemResponse>
+ */
+export const exportItem = (requestOptions: IExportItemRequestOptions) : Promise<IExportItemResponse> => {
+  const {
+    authentication,
+    id: itemId,
+    title,
+    exportFormat,
+    exportParameters
+  } = requestOptions;
+
+  return determineOwner(requestOptions)
+    .then(owner => `${getPortalUrl(requestOptions)}/content/users/${owner}/export`)
+    .then(url => request(url, {
+        httpMethod: 'POST',
+        authentication,
+        params: {
+          itemId,
+          title,
+          exportFormat,
+          exportParameters
+        }
+      })
+    );
+}