autnam 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 { getPortalUrl } from "../util/get-portal-url.js";
+import { request, IUserRequestOptions } 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 "../helpers.js";
+import { getPortalUrl } from "../util/get-portal-url.js";
+
+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/helpers.ts

@@ -0,0 +1,83 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  ISpatialReference
+} from "@esri/arcgis-rest-request";
+
+/**
+ * A Portal [Item](https://developers.arcgis.com/rest/users-groups-and-items/common-parameters.htm) that has not been created yet.
+ */
+ export interface IItemAdd {
+  title: string;
+  type: string;
+  owner?: string;
+  typeKeywords?: string[];
+  description?: string;
+  snippet?: string;
+  documentation?: string;
+  extent?: number[][];
+  categories?: string[];
+  spatialReference?: ISpatialReference;
+  culture?: string;
+  properties?: any;
+  url?: string;
+  tags?: string[];
+  [key: string]: any;
+}
+
+/**
+ * A Portal [Item](https://developers.arcgis.com/rest/users-groups-and-items/common-parameters.htm) to be updated.
+ */
+export interface IItemUpdate {
+  id: string;
+  [key: string]: any;
+}
+
+/**
+ * Existing Portal [Item](https://developers.arcgis.com/rest/users-groups-and-items/item.htm).
+ */
+export interface IItem extends IItemAdd {
+  id: string;
+  owner: string;
+  tags: string[];
+  created: number;
+  modified: number;
+  numViews: number;
+  size: number;
+  protected?: boolean; // not present in search results
+}
+
+/**
+ * Used for organizing content. See [Create Folder](https://developers.arcgis.com/rest/users-groups-and-items/create-folder.htm) for more details.
+ */
+export interface IFolder {
+  username: string;
+  id: string;
+  title: string;
+  created?: number;
+}
+
+/**
+ * Params for paging operations
+ */
+ export interface IPagingParams {
+  start?: number;
+  num?: number;
+}
+/**
+ * Paging properties for paged responses.
+ */
+export interface IPagedResponse extends IPagingParams {
+  /** total number of object across all pages */
+  total: number;
+  /** next entry index or -1 for the last page */
+  nextStart: number;
+}
+
+/**
+ * Response from the portals/Self/isServiceNameAvailable request
+ */
+ export interface IServiceNameAvailable {
+  available: boolean;
+}

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

@@ -0,0 +1,68 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export * from "./items/add.js";
+export * from "./items/content.js";
+export * from "./items/create.js";
+export * from "./items/export.js";
+export * from "./items/get.js";
+export * from "./items/protect.js";
+export * from "./items/reassign.js";
+export * from "./items/remove.js";
+export * from "./items/search.js";
+export * from "./items/update.js";
+export * from "./items/helpers.js";
+export * from "./items/upload.js";
+
+export * from "./groups/add-users.js";
+export * from "./groups/remove-users.js";
+export * from "./groups/invite-users.js";
+export * from "./groups/create.js";
+export * from "./groups/get.js";
+export * from "./groups/helpers.js";
+export * from "./groups/notification.js";
+export * from "./groups/protect.js";
+export * from "./groups/remove.js";
+export * from "./groups/search.js";
+export * from "./groups/update.js";
+export * from "./groups/update-user-membership.js";
+export * from "./groups/join.js";
+
+export * from "./orgs/notification.js";
+
+export * from "./users/get-user.js";
+export * from "./users/get-user-tags.js";
+export * from "./users/get-user-url.js";
+export * from "./users/invitation.js";
+export * from "./users/notification.js";
+export * from "./users/search-users.js";
+export * from "./users/update.js";
+
+export * from "./sharing/access.js";
+export * from "./sharing/share-item-with-group.js";
+export * from "./sharing/unshare-item-with-group.js";
+export * from "./sharing/is-item-shared-with-group.js";
+export * from "./sharing/helpers.js";
+
+export * from "./services/get-unique-service-name.js";
+export * from "./services/is-service-name-available.js";
+
+export * from "./util/get-portal.js";
+export * from "./util/get-portal-settings.js";
+export * from "./util/get-portal-url.js";
+export * from "./util/scrub-control-chars.js";
+export * from "./util/search.js";
+export * from "./util/SearchQueryBuilder.js";
+
+// we dont export 'generic-search' because its an internal utility method
+// export * from "./util/generic-search"; because its an internal utility method
+
+// Types that are used in this package are re-exported for convenience and 
+// to make the links work correctly in the documentation pages.
+export * from './helpers.js';
+export type {
+  IUser,
+  IGroup,
+  IGroupAdd,
+  GroupMembership
+} from "@esri/arcgis-rest-request";

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

@@ -0,0 +1,145 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, appendCustomParams } from "@esri/arcgis-rest-request";
+import type { Blob, File } from "@esri/arcgis-rest-request";
+
+import { getPortalUrl } from "../util/get-portal-url.js";
+import {
+  IUserItemOptions,
+  IItemResourceOptions,
+  IUpdateItemResponse,
+  IItemResourceResponse,
+  determineOwner,
+  IManageItemRelationshipOptions
+} from "./helpers.js";
+
+import { updateItem, IUpdateItemOptions } from "./update.js";
+
+export interface IAddItemDataOptions extends IUserItemOptions {
+  /**
+   * The [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) or [File](https://developer.mozilla.org/en-US/docs/Web/API/File) to store. In Node JS `File` and `Blob` can be imported from `@esri/arcgis-rest-request`
+   */
+  file?: Blob | File;
+  /**
+   * Text content to store/
+   */
+  text?: string;
+}
+
+/**
+ * ```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,
+      text: requestOptions.text,
+      file: requestOptions.file
+    },
+    ...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,70 @@
+import { 
+  request,
+  IRequestOptions,
+} from "@esri/arcgis-rest-request";
+import { IItem, IFolder, IPagingParams, IPagedResponse } from "../helpers.js";
+
+import { getPortalUrl } from "../util/get-portal-url.js";
+import { determineOwner } from "./helpers.js";
+
+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,149 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, appendCustomParams } from "@esri/arcgis-rest-request";
+import { IItemAdd } from "../helpers.js";
+
+import { getPortalUrl } from "../util/get-portal-url.js";
+import {
+  IAddFolderResponse,
+  IUpdateItemResponse,
+  ICreateUpdateItemOptions,
+  determineOwner
+} from "./helpers.js";
+
+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: ArcGISIdentityManager
+ * })
+ *   .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,
+      ...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);
+}