ducimusipsa 1.0.0

package/packages/arcgis-rest-groups/test/search.test.ts

@@ -0,0 +1,85 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { searchGroups } from "../src/search";
+
+import { GroupSearchResponse } from "./mocks/responses";
+
+import * as fetchMock from "fetch-mock";
+
+describe("groups", () => {
+  afterEach(fetchMock.restore);
+
+  describe("searchGroups", () => {
+    it("should make a simple, unauthenticated group search request", done => {
+      fetchMock.once("*", GroupSearchResponse);
+
+      searchGroups({ q: "water" })
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://www.arcgis.com/sharing/rest/community/groups?f=json&q=water"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+
+    it("should take num, start, sortField, sortOrder and construct the request", done => {
+      fetchMock.once("*", GroupSearchResponse);
+      searchGroups({
+        q: "water",
+        start: 4,
+        num: 7,
+        sortField: "owner",
+        sortOrder: "desc"
+      })
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://www.arcgis.com/sharing/rest/community/groups?f=json&q=water&start=4&num=7&sortField=owner&sortOrder=desc"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  });
+
+  describe("authenticted methods", () => {
+    const MOCK_AUTH = {
+      getToken() {
+        return Promise.resolve("fake-token");
+      },
+      portal: "https://myorg.maps.arcgis.com/sharing/rest"
+    };
+    const MOCK_REQOPTS = {
+      authentication: MOCK_AUTH
+    };
+
+    it("should make a simple, authenticated group search request", done => {
+      fetchMock.once("*", GroupSearchResponse);
+
+      searchGroups({ q: "water" }, MOCK_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/community/groups?f=json&q=water&token=fake-token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
+  });
+});

package/packages/arcgis-rest-groups/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": [
+      "src/**/*.ts"
+  ]
+}

package/packages/arcgis-rest-items/README.md

@@ -0,0 +1,69 @@
+[![npm version][npm-img]][npm-url]
+[![build status][travis-img]][travis-url]
+[![Coverage Status][coverage-img]][coverage-url]
+[![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/arcgis-rest-js/master/LICENSE)
+
+[npm-img]: https://img.shields.io/npm/v/@esri/arcgis-rest-items.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-items
+[travis-img]: https://img.shields.io/travis/Esri/arcgis-rest-js/master.svg?style=flat-square
+[travis-url]: https://travis-ci.org/Esri/arcgis-rest-js
+[coverage-img]: https://coveralls.io/repos/github/Esri/arcgis-rest-js/badge.svg
+[coverage-url]: https://coveralls.io/github/Esri/arcgis-rest-js
+
+# @esri/arcgis-rest-items
+
+> A module for working with content in the ArcGIS REST API that runs in Node.js and modern browsers.
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+npm install @esri/arcgis-rest-items
+```
+
+```js
+import { getItem } from '@esri/arcgis-rest-items';
+
+const itemId = "30e5fe3149c34df1ba922e6f5bbf808f";
+
+getItem(itemId)
+    .then(response => {
+        console.log(response.title) // World Topographic Map
+    });
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/items/)
+
+### Issues
+
+If something isn't working the way you expected, please take a look at [previously logged issues](https://github.com/Esri/arcgis-rest-js/issues) first.  Have you found a new bug?  Want to request a new feature?  We'd [**love**](https://github.com/Esri/arcgis-rest-js/issues/new) to hear from you.
+
+If you're looking for help you can also post issues on [GIS Stackexchange](http://gis.stackexchange.com/questions/ask?tags=esri-oss).
+
+### Versioning
+
+For transparency into the release cycle and in striving to maintain backward compatibility, @esri/arcgis-rest-js is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible.
+
+For more information on SemVer, please visit <http://semver.org/>.
+
+### Contributing
+
+Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](CONTRIBUTING.md).
+
+### License
+
+Copyright &copy; 2017-2018 Esri
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+> http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+A copy of the license is available in the repository's [LICENSE](../../LICENSE) file.

package/packages/arcgis-rest-items/package-lock.json

@@ -0,0 +1,11 @@
+{
+	"requires": true,
+	"lockfileVersion": 1,
+	"dependencies": {
+		"tslib": {
+			"version": "1.8.0",
+			"resolved": "https://registry.npmjs.org/tslib/-/tslib-1.8.0.tgz",
+			"integrity": "sha512-ymKWWZJST0/CkgduC2qkzjMOWr4bouhuURNXCn/inEX0L57BnRG6FhX76o7FOnsjHazCjfU2LKeSrlS2sIKQJg=="
+		}
+	}
+}

package/packages/arcgis-rest-items/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@esri/arcgis-rest-items",
+  "version": "1.14.1",
+  "description": "Portal Item helpers for @esri/arcgis-rest-request",
+  "main": "dist/node/index.js",
+  "browser": "dist/umd/items.umd.js",
+  "module": "dist/esm/index.js",
+  "js:next": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "license": "Apache-2.0",
+  "files": [
+    "dist/**"
+  ],
+  "dependencies": {
+    "tslib": "^1.7.1"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-auth": "^1.14.1",
+    "@esri/arcgis-rest-common-types": "^1.14.1",
+    "@esri/arcgis-rest-request": "^1.14.1"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-auth": "^1.14.1",
+    "@esri/arcgis-rest-common-types": "^1.14.1",
+    "@esri/arcgis-rest-request": "^1.14.1"
+  },
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "npm run build:node && npm run build:umd && npm run build:esm",
+    "build:esm": "tsc -p ./tsconfig.json --module es2015 --outDir ./dist/esm --declaration",
+    "build:umd": "rollup -c ../../umd-base-profile.js && rollup -c ../../umd-production-profile.js",
+    "build:node": "tsc -p ./tsconfig.json --module commonjs --outDir ./dist/node",
+    "dev:esm": "tsc -w --module es2015 --outDir ./dist/esm --declaration",
+    "dev:umd": "rollup -w -c ../../umd-base-profile.js",
+    "dev:node": "tsc -w --module commonjs --outDir ./dist/node"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Esri/arcgis-rest-js.git"
+  },
+  "contributors": [
+    {
+      "name": "Dave Bouwman",
+      "email": "dbouwman@esri.com",
+      "url": "http://blog.davebouwman.com/"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "homepage": "https://github.com/Esri/arcgis-rest-js#readme"
+}

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

@@ -0,0 +1,103 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, getPortalUrl } from "@esri/arcgis-rest-request";
+
+import {
+  IItemIdRequestOptions,
+  IItemResourceRequestOptions,
+  IItemAddResponse,
+  IItemResourceResponse,
+  determineOwner
+} from "./helpers";
+
+export interface IItemDataAddRequestOptions extends IItemIdRequestOptions {
+  /**
+   * Object to store
+   */
+  data: any;
+}
+
+export interface IItemResourceAddRequestOptions
+  extends IItemResourceRequestOptions {
+  /**
+   * Object to store
+   */
+  resource: any;
+}
+
+/**
+ * Send json to an item to be stored as the `/data` resource
+ *
+ * @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 addItemJsonData(
+  requestOptions: IItemDataAddRequestOptions
+): Promise<IItemAddResponse> {
+  const owner = determineOwner(requestOptions);
+  const url = `${getPortalUrl(requestOptions)}/content/users/${owner}/items/${
+    requestOptions.id
+  }/update`;
+
+  // Portal API requires that the 'data' be stringified and POSTed in
+  // a `text` form field. It can also be sent with the `.create` call by sending
+  // a `.data` property.
+  requestOptions.params = {
+    text: JSON.stringify(requestOptions.data),
+    ...requestOptions.params
+  };
+
+  return request(url, requestOptions);
+}
+
+/**
+ * Send a file or blob to an item to be stored as the `/data` resource
+ *
+ * @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: IItemDataAddRequestOptions
+): Promise<IItemAddResponse> {
+  const owner = determineOwner(requestOptions);
+
+  const url = `${getPortalUrl(requestOptions)}/content/users/${owner}/items/${
+    requestOptions.id
+  }/update`;
+
+  // Portal API requires that the 'data' be POSTed in a `file` form field.
+  requestOptions.params = {
+    file: requestOptions.data,
+    ...requestOptions.params
+  };
+
+  return request(url, requestOptions);
+}
+
+/**
+ * Add a resource associated with an item
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise to add item resources.
+ */
+export function addItemResource(
+  requestOptions: IItemResourceAddRequestOptions
+): 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-items/src/create.ts

@@ -0,0 +1,110 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, getPortalUrl } from "@esri/arcgis-rest-request";
+
+import { IItemAdd } from "@esri/arcgis-rest-common-types";
+
+import {
+  IAddFolderResponse,
+  IItemAddResponse,
+  IItemCrudRequestOptions,
+  serializeItem,
+  determineOwner
+} from "./helpers";
+
+export interface IAddFolderRequestOptions extends IItemCrudRequestOptions {
+  /**
+   * Name of the folder to create.
+   */
+  title: string;
+}
+
+export interface IItemAddRequestOptions extends IItemCrudRequestOptions {
+  item: IItemAdd;
+}
+
+/**
+ * Create a folder
+ *
+ * ```js
+ * import { createFolder } from '@esri/arcgis-rest-items';
+ *
+ * createFolder({
+ *   title: 'Map Collection',
+ *   authentication: userSession
+ * }) ```
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that resolves with folder details once the folder has been created
+ */
+export function createFolder(
+  requestOptions: IAddFolderRequestOptions
+): 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);
+}
+
+/**
+ * Create an item in a folder
+ *
+ * @param requestOptions = Options for the request
+ */
+export function createItemInFolder(
+  requestOptions: IItemAddRequestOptions
+): Promise<IItemAddResponse> {
+  const owner = determineOwner(requestOptions);
+
+  const baseUrl = `${getPortalUrl(requestOptions)}/content/users/${owner}`;
+  let url = `${baseUrl}/addItem`;
+
+  if (requestOptions.folder) {
+    url = `${baseUrl}/${requestOptions.folder}/addItem`;
+  }
+
+  // serialize the item into something Portal will accept
+  requestOptions.params = {
+    ...requestOptions.params,
+    ...serializeItem(requestOptions.item)
+  };
+
+  return request(url, requestOptions);
+}
+
+/**
+ * Create an Item in the user's root folder
+ *
+ * ```js
+ * import { createItem } from '@esri/arcgis-rest-items';
+ *
+ * createItem({
+ *   authentication: userSession,
+ *   item: {
+ *     title: "The Amazing Voyage",
+ *     type: "Web Map"
+ *   }
+ * })
+ * ```
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that creates an item.
+ */
+export function createItem(
+  requestOptions: IItemAddRequestOptions
+): Promise<IItemAddResponse> {
+  // delegate to createItemInFolder placing in the root of the filestore
+  const options = {
+    folder: null,
+    ...requestOptions
+  } as IItemAddRequestOptions;
+  return createItemInFolder(options);
+}

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

@@ -0,0 +1,79 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  request,
+  IRequestOptions,
+  getPortalUrl
+} from "@esri/arcgis-rest-request";
+
+import { IItem } from "@esri/arcgis-rest-common-types";
+
+import { IItemIdRequestOptions, IItemDataRequestOptions } from "./helpers";
+
+/**
+ * Get an item by id
+ *
+ * @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);
+}
+
+/**
+ * Get the /data for an item.
+ * @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?: IItemDataRequestOptions
+): Promise<any> {
+  const url = `${getPortalUrl(requestOptions)}/content/items/${id}/data`;
+  // default to a GET request
+  const options: IItemDataRequestOptions = {
+    ...{ httpMethod: "GET", params: {} },
+    ...requestOptions
+  };
+
+  if (options.file) {
+    options.params.f = null;
+  }
+
+  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(
+  requestOptions: IItemIdRequestOptions
+): Promise<any> {
+  const url = `${getPortalUrl(requestOptions)}/content/items/${
+    requestOptions.id
+  }/resources`;
+
+  // mix in user supplied params
+  requestOptions.params = {
+    ...requestOptions.params,
+    num: 1000
+  };
+
+  return request(url, requestOptions);
+}

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

@@ -0,0 +1,147 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+
+import { IItemAdd, IItemUpdate, IItem } from "@esri/arcgis-rest-common-types";
+
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+
+export interface IItemRequestOptions extends IUserRequestOptions {
+  item: IItem;
+}
+
+export interface IItemIdRequestOptions extends IUserRequestOptions {
+  /**
+   * Unique identifier of the item.
+   */
+  id: string;
+  /**
+   * Item owner username. If not present, `authentication.username` is utilized.
+   */
+  owner?: string;
+}
+
+export interface IItemResourceRequestOptions extends IItemIdRequestOptions {
+  /**
+   * New resource filename.
+   */
+  name?: string;
+  /**
+   * Text input to be added as a file resource.
+   */
+  content?: string;
+  /**
+   * Controls whether access to the file resource is restricted to the owner or inherited from the sharing permissions set for the associated item.
+   */
+  private?: boolean;
+  resource?: any;
+}
+
+export interface IItemCrudRequestOptions extends IUserRequestOptions {
+  /**
+   * The owner of the item. If this property is not present, `item.owner` will be passed, or lastly `authentication.username`.
+   */
+  owner?: string;
+  /**
+   * Id of the folder to house the item.
+   */
+  folder?: string;
+}
+
+export interface IItemDataRequestOptions extends IRequestOptions {
+  /**
+   * Used to request binary data.
+   */
+  file?: boolean;
+}
+
+export interface IItemUpdateResponse {
+  success: boolean;
+  id: string;
+}
+
+export interface IItemAddResponse extends IItemUpdateResponse {
+  folder: string;
+}
+
+export interface IItemResourceResponse {
+  success: boolean;
+  itemId: string;
+  owner: string;
+  folder: string;
+}
+
+export interface IAddFolderResponse {
+  /**
+   * Success or failure of request.
+   */
+  success: boolean;
+  /**
+   * Information about created folder: its alphanumeric id, name, and owner's name.
+   */
+  folder: {
+    id: string;
+    title: string;
+    username: string;
+  };
+}
+
+export interface IItemMoveResponse {
+  /**
+   * Success or failure of request.
+   */
+  success: boolean;
+  /**
+   * Alphanumeric id of moved item.
+   */
+  itemId: string;
+  /**
+   * Name of owner of item.
+   */
+  owner: string;
+  /**
+   * Alphanumeric id of folder now housing item.
+   */
+  folder: string;
+}
+
+/**
+ * Serialize an item into a json format accepted by the Portal API
+ * for create and update operations
+ *
+ * @param item Item to be serialized
+ * @returns a formatted json object to be sent to Portal
+ */
+export function serializeItem(item: IItemAdd | IItemUpdate | IItem): any {
+  // create a clone so we're not messing with the original
+  const clone = JSON.parse(JSON.stringify(item));
+  // join keywords and tags...
+  const { typeKeywords = [], tags = [] } = item;
+  clone.typeKeywords = typeKeywords.join(", ");
+  clone.tags = tags.join(", ");
+  // convert .data to .text
+  if (clone.data) {
+    clone.text = JSON.stringify(clone.data);
+    delete clone.data;
+  }
+  // Convert properties to a string
+  if (clone.properties) {
+    clone.properties = JSON.stringify(clone.properties);
+  }
+  return clone;
+}
+
+/**
+ * requestOptions.owner is given priority, requestOptions.item.owner will be checked next. If neither are present, authentication.username will be assumed.
+ */
+export function determineOwner(requestOptions: any): string {
+  if (requestOptions.owner) {
+    return requestOptions.owner;
+  }
+  if (requestOptions.item && requestOptions.item.owner) {
+    return requestOptions.item.owner;
+  } else {
+    return requestOptions.authentication.username;
+  }
+}

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

@@ -0,0 +1,11 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+export * from "./add";
+export * from "./create";
+export * from "./get";
+export * from "./protect";
+export * from "./remove";
+export * from "./search";
+export * from "./update";
+export * from "./helpers";