ducimusipsa 1.0.0

package/packages/arcgis-rest-items/src/protect.ts

@@ -0,0 +1,38 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, getPortalUrl } from "@esri/arcgis-rest-request";
+
+import { IItemIdRequestOptions, determineOwner } from "./helpers";
+
+/**
+ * Protect an item
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise to protect an item.
+ */
+export function protectItem(
+  requestOptions: IItemIdRequestOptions
+): Promise<any> {
+  const owner = determineOwner(requestOptions);
+  const url = `${getPortalUrl(requestOptions)}/content/users/${owner}/items/${
+    requestOptions.id
+  }/protect`;
+  return request(url, requestOptions);
+}
+
+/**
+ * Unprotect an item
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise to unprotect an item.
+ */
+export function unprotectItem(
+  requestOptions: IItemIdRequestOptions
+): Promise<any> {
+  const owner = determineOwner(requestOptions);
+  const url = `${getPortalUrl(requestOptions)}/content/users/${owner}/items/${
+    requestOptions.id
+  }/unprotect`;
+  return request(url, requestOptions);
+}

package/packages/arcgis-rest-items/src/remove.ts

@@ -0,0 +1,58 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, getPortalUrl } from "@esri/arcgis-rest-request";
+
+import {
+  IItemIdRequestOptions,
+  IItemResourceRequestOptions,
+  determineOwner
+} from "./helpers";
+
+/**
+ * Remove an item from the portal
+ *
+ * *
+ * ```js
+ * import { removeItem } from '@esri/arcgis-rest-items';
+ *
+ * removeItem({
+ *   authentication: userSession,
+ *   id: "3ef"
+ * })
+ * ```
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that deletes an item.
+ */
+export function removeItem(
+  requestOptions: IItemIdRequestOptions
+): Promise<any> {
+  const owner = determineOwner(requestOptions);
+  const url = `${getPortalUrl(requestOptions)}/content/users/${owner}/items/${
+    requestOptions.id
+  }/delete`;
+  return request(url, requestOptions);
+}
+
+/**
+ * Remove a resource associated with an item
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that deletes an item resource.
+ */
+export function removeItemResource(
+  requestOptions: IItemResourceRequestOptions
+): Promise<any> {
+  const owner = determineOwner(requestOptions);
+  const url = `${getPortalUrl(requestOptions)}/content/users/${owner}/items/${
+    requestOptions.id
+  }/removeResources`;
+
+  // mix in user supplied params
+  requestOptions.params = {
+    ...requestOptions.params,
+    resource: requestOptions.resource
+  };
+  return request(url, requestOptions);
+}

package/packages/arcgis-rest-items/src/search.ts

@@ -0,0 +1,78 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  getPortalUrl
+} from "@esri/arcgis-rest-request";
+
+import { IPagingParams, IItem } from "@esri/arcgis-rest-common-types";
+
+// this interface still needs to be docced
+export interface ISearchRequest extends IPagingParams {
+  q: string;
+  [key: string]: any;
+}
+
+export interface ISearchRequestOptions extends IRequestOptions {
+  searchForm?: ISearchRequest;
+}
+
+/**
+ * Options to pass through when searching for items.
+ */
+export interface ISearchResult {
+  query: string; // matches the api's form param
+  total: number;
+  start: number;
+  num: number;
+  nextStart: number;
+  results: IItem[];
+}
+
+/**
+ * Search for items via the portal api
+ *
+ * ```js
+ * import { searchItems } from '@esri/arcgis-rest-items';
+ *
+ * searchItems('water')
+ * .then((results) => {
+ *  console.log(results.total); // 355
+ * })
+ * ```
+ *
+ * @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 searchItems(
+  search: string | ISearchRequestOptions
+): Promise<ISearchResult> {
+  let options: ISearchRequestOptions = {
+    httpMethod: "GET",
+    params: {}
+  };
+
+  if (typeof search === "string") {
+    options.params.q = search;
+  } else {
+    // mixin user supplied requestOptions with defaults
+    options = {
+      ...options,
+      ...search
+    };
+
+    // mixin arbitrary request parameters with search form
+    options.params = {
+      ...search.params,
+      ...search.searchForm
+    };
+  }
+
+  // construct the search url
+  const url = `${getPortalUrl(options)}/search`;
+
+  // send the request
+  return request(url, options);
+}

package/packages/arcgis-rest-items/src/update.ts

@@ -0,0 +1,134 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, getPortalUrl } from "@esri/arcgis-rest-request";
+
+import { IItemUpdate } from "@esri/arcgis-rest-common-types";
+
+import {
+  IItemCrudRequestOptions,
+  IItemMoveResponse,
+  IItemResourceRequestOptions,
+  IItemUpdateResponse,
+  serializeItem,
+  determineOwner
+} from "./helpers";
+
+export interface IItemUpdateRequestOptions extends IItemCrudRequestOptions {
+  item: IItemUpdate;
+}
+
+export interface IItemMoveRequestOptions extends IItemCrudRequestOptions {
+  /**
+   * Alphanumeric id of item to be moved.
+   */
+  itemId: string;
+  /**
+   * Alphanumeric id of folder to house moved item. If null, empty, or "/", the destination is the
+   * root folder.
+   */
+  folderId?: string;
+}
+
+/**
+ * Update an Item. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/update-item.htm) for more information.
+ *
+ * ```js
+ * import { updateItem } from '@esri/arcgis-rest-items';
+ *
+ * updateItem({
+ *   authentication: userSession,
+ *   item: {
+ *     id: "3ef",
+ *     description: "A three hour tour"
+ *   }
+ * })
+ * ```
+ *
+ * @param item - The item to update.
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that updates an item.
+ */
+export function updateItem(
+  requestOptions: IItemUpdateRequestOptions
+): Promise<IItemUpdateResponse> {
+  const owner = determineOwner(requestOptions);
+  const url = `${getPortalUrl(requestOptions)}/content/users/${owner}/items/${
+    requestOptions.item.id
+  }/update`;
+
+  // serialize the item into something Portal will accept
+  requestOptions.params = {
+    ...requestOptions.params,
+    ...serializeItem(requestOptions.item)
+  };
+
+  return request(url, requestOptions);
+}
+
+/**
+ * Update a resource associated with an item
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that updates an item resource.
+ */
+export function updateItemResource(
+  requestOptions: IItemResourceRequestOptions
+): Promise<any> {
+  const owner = determineOwner(requestOptions);
+  const url = `${getPortalUrl(requestOptions)}/content/users/${owner}/items/${
+    requestOptions.id
+  }/updateResources`;
+
+  // mix in user supplied params
+  requestOptions.params = {
+    file: requestOptions.resource,
+    fileName: requestOptions.name,
+    text: requestOptions.content,
+    ...requestOptions.params
+  };
+
+  // only override whatever access was specified previously if 'private' was passed explicitly
+  if (typeof requestOptions.private !== "undefined") {
+    requestOptions.params.access = requestOptions.private
+      ? "private"
+      : "inherit";
+  }
+
+  return request(url, requestOptions);
+}
+
+/**
+ * Move an item to a folder
+ *
+ * ```js
+ * import { moveItem } from '@esri/arcgis-rest-items';
+ *
+ * moveItem({
+ *   itemId: "3ef",
+ *   folderId: "7c5",
+ *   authentication: userSession
+ * }) ```
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that resolves with owner and folder details once the move has been completed
+ */
+export function moveItem(
+  requestOptions: IItemMoveRequestOptions
+): Promise<IItemMoveResponse> {
+  const owner = determineOwner(requestOptions);
+  const url = `${getPortalUrl(requestOptions)}/content/users/${owner}/items/${
+    requestOptions.itemId
+  }/move`;
+
+  let folderId = requestOptions.folderId;
+  if (!folderId) {
+    folderId = "/";
+  }
+  requestOptions.params = {
+    folder: folderId,
+    ...requestOptions.params
+  };
+
+  return request(url, requestOptions);
+}

package/packages/arcgis-rest-items/test/add.test.ts

@@ -0,0 +1,256 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import * as fetchMock from "fetch-mock";
+
+import { attachmentFile } from "../../arcgis-rest-feature-service/test/attachments.test";
+
+import { addItemJsonData, addItemData, addItemResource } from "../src/add";
+
+import { ItemSuccessResponse } from "./mocks/item";
+
+import { UserSession } from "@esri/arcgis-rest-auth";
+import { TOMORROW } from "@esri/arcgis-rest-auth/test/utils";
+import { encodeParam } from "@esri/arcgis-rest-request";
+
+describe("search", () => {
+  afterEach(fetchMock.restore);
+
+  describe("Authenticated methods", () => {
+    // setup a UserSession to use in all these tests
+    const MOCK_USER_SESSION = new UserSession({
+      clientId: "clientId",
+      redirectUri: "https://example-app.com/redirect-uri",
+      token: "fake-token",
+      tokenExpires: TOMORROW,
+      refreshToken: "refreshToken",
+      refreshTokenExpires: TOMORROW,
+      refreshTokenTTL: 1440,
+      username: "casey",
+      password: "123456",
+      portal: "https://myorg.maps.arcgis.com/sharing/rest"
+    });
+
+    const MOCK_USER_REQOPTS = {
+      authentication: MOCK_USER_SESSION
+    };
+
+    it("should add data to an item", done => {
+      fetchMock.once("*", ItemSuccessResponse);
+      const fakeData = {
+        values: {
+          key: "someValue"
+        }
+      };
+      // addItemJsonData("3ef", "dbouwman", fakeData, MOCK_REQOPTS)
+      addItemJsonData({
+        id: "3ef",
+        owner: "dbouwman",
+        data: fakeData,
+        ...MOCK_USER_REQOPTS
+      })
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/content/users/dbouwman/items/3ef/update"
+          );
+          expect(options.method).toBe("POST");
+
+          expect(options.body).toContain("f=json");
+          expect(options.body).toContain("token=fake-token");
+          expect(options.body).toContain(
+            encodeParam("text", JSON.stringify(fakeData))
+          );
+
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should add data to an item, no owner passed", done => {
+      fetchMock.once("*", ItemSuccessResponse);
+      const fakeData = {
+        values: {
+          key: "someValue"
+        }
+      };
+      // addItemJsonData("3ef", "dbouwman", fakeData, MOCK_REQOPTS)
+      addItemJsonData({
+        id: "3ef",
+        data: fakeData,
+        ...MOCK_USER_REQOPTS
+      })
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/items/3ef/update"
+          );
+          expect(options.method).toBe("POST");
+
+          expect(options.body).toContain("f=json");
+          expect(options.body).toContain("token=fake-token");
+          expect(options.body).toContain(
+            encodeParam("text", JSON.stringify(fakeData))
+          );
+
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should add data to an item, extra parameters", done => {
+      fetchMock.once("*", ItemSuccessResponse);
+      const fakeData = {
+        values: {
+          key: "someValue"
+        }
+      };
+      // addItemJsonData("3ef", "dbouwman", fakeData, MOCK_REQOPTS)
+      addItemJsonData({
+        id: "3ef",
+        data: fakeData,
+        ...MOCK_USER_REQOPTS,
+        params: {
+          relationshipType: "WMA2Code"
+        }
+      })
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/items/3ef/update"
+          );
+          expect(options.method).toBe("POST");
+          expect(options.body).toContain("relationshipType=WMA2Code");
+          expect(options.body).toContain("f=json");
+          expect(options.body).toContain("token=fake-token");
+          expect(options.body).toContain(
+            encodeParam("text", JSON.stringify(fakeData))
+          );
+
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should add binary item data by id", done => {
+      fetchMock.once("*", {
+        success: true
+      });
+
+      const file = attachmentFile();
+
+      addItemData({
+        id: "3ef",
+        // File() is only available in the browser
+        data: file,
+        ...MOCK_USER_REQOPTS
+      })
+        .then(() => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/items/3ef/update"
+          );
+          expect(options.method).toBe("POST");
+          expect(options.body instanceof FormData).toBeTruthy();
+          const params = options.body as FormData;
+          if (params.get) {
+            expect(params.get("token")).toEqual("fake-token");
+            expect(params.get("f")).toEqual("json");
+            expect(params.get("file")).toEqual(file);
+          }
+
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should add a binary resource to an item", done => {
+      fetchMock.once("*", {
+        success: true
+      });
+
+      const file = attachmentFile();
+
+      addItemResource({
+        id: "3ef",
+        // File() is only available in the browser
+        resource: file,
+        name: "thebigkahuna",
+        ...MOCK_USER_REQOPTS
+      })
+        .then(() => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/items/3ef/addResources"
+          );
+          expect(options.method).toBe("POST");
+          expect(options.body instanceof FormData).toBeTruthy();
+          const params = options.body as FormData;
+          if (params.get) {
+            expect(params.get("token")).toEqual("fake-token");
+            expect(params.get("f")).toEqual("json");
+            expect(params.get("file")).toEqual(file);
+            expect(params.get("access")).toEqual("inherit");
+            expect(params.get("fileName")).toEqual("thebigkahuna");
+          }
+
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should add a binary resource to a secret item", done => {
+      fetchMock.once("*", {
+        success: true
+      });
+
+      const file = attachmentFile();
+
+      addItemResource({
+        id: "3ef",
+        // File() is only available in the browser
+        resource: file,
+        name: "thebigkahuna",
+        private: true,
+        ...MOCK_USER_REQOPTS
+      })
+        .then(() => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/content/users/casey/items/3ef/addResources"
+          );
+          expect(options.method).toBe("POST");
+          expect(options.body instanceof FormData).toBeTruthy();
+          const params = options.body as FormData;
+          if (params.get) {
+            expect(params.get("token")).toEqual("fake-token");
+            expect(params.get("f")).toEqual("json");
+            expect(params.get("file")).toEqual(file);
+            expect(params.get("access")).toEqual("private");
+            expect(params.get("fileName")).toEqual("thebigkahuna");
+          }
+
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  }); // auth requests
+});