autnam 1.0.0

package/packages/arcgis-rest-portal/test/util/portal.test.ts

@@ -0,0 +1,137 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import fetchMock from "fetch-mock";
+import { getSelf, getPortal } from "../../src/util/get-portal.js";
+import { getSubscriptionInfo } from "../../src/util/get-subscription-info.js";
+
+import {
+  PortalResponse,
+  SubscriptionInfoResponse
+} from "./../mocks/portal/response.js";
+
+describe("portal", () => {
+  afterEach(fetchMock.restore);
+
+  describe("getPortal", () => {
+    // setup an authmgr to use in all these tests
+    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 get the portal by id", (done) => {
+      fetchMock.once("*", PortalResponse);
+      getPortal("5BZFaKe", 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/portals/5BZFaKe?f=json&token=fake-token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch((e) => {
+          fail(e);
+        });
+    });
+    it("should get the portal self if no id", (done) => {
+      fetchMock.once("*", PortalResponse);
+      getPortal(null, 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/portals/self?f=json&token=fake-token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch((e) => {
+          fail(e);
+        });
+    });
+  });
+  describe("getSelf", () => {
+    // setup an authmgr to use in all these tests
+    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 get the portal by id", (done) => {
+      fetchMock.once("*", PortalResponse);
+      getSelf(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/portals/self?f=json&token=fake-token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch((e) => {
+          fail(e);
+        });
+    });
+  });
+
+  describe("getSubscriptionInfo", () => {
+    // setup an authmgr to use in all these tests
+    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 get the portal subscriptionInfo by id", (done) => {
+      fetchMock.once("*", SubscriptionInfoResponse);
+      getSubscriptionInfo("5BZFaKe", 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/portals/5BZFaKe/subscriptionInfo?f=json&token=fake-token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch((e) => {
+          fail(e);
+        });
+    });
+
+    it("should get the portal self subscriptionInfo if no id", (done) => {
+      fetchMock.once("*", SubscriptionInfoResponse);
+      getSubscriptionInfo(null, 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/portals/self/subscriptionInfo?f=json&token=fake-token"
+          );
+          expect(options.method).toBe("GET");
+          done();
+        })
+        .catch((e) => {
+          fail(e);
+        });
+    });
+  });
+});

package/packages/arcgis-rest-portal/test/util/scrub-control-chars.test.ts

@@ -0,0 +1,25 @@
+import { scrubControlChars } from "../../src/util/scrub-control-chars.js";
+
+describe("scrubControlChars", function () {
+  it("removes control characters", function () {
+    let hasAllControlChars = "foo";
+    // C0
+    for (let i = 0; i < 32; i++) {
+      hasAllControlChars += String.fromCharCode(i);
+    }
+    hasAllControlChars += "bar";
+    // C1
+    for (let i = 128; i < 159; i++) {
+      hasAllControlChars += String.fromCharCode(i);
+    }
+    hasAllControlChars += "baz";
+
+    // ISO 8859 special char
+    hasAllControlChars += String.fromCharCode(160);
+
+    expect(scrubControlChars(hasAllControlChars)).toBe(
+      "foobarbaz",
+      "removes all control chars"
+    );
+  });
+});

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

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

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

@@ -0,0 +1,72 @@
+[![npm version][npm-img]][npm-url]
+[![build status][travis-img]][travis-url]
+[![gzip bundle size][gzip-image]][npm-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-request.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-request
+[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
+[gzip-image]: https://img.badgesize.io/https://unpkg.com/@esri/arcgis-rest-request/dist/bundled/request.umd.min.js?compression=gzip
+[coverage-img]: https://codecov.io/gh/Esri/arcgis-rest-js/branch/master/graph/badge.svg
+[coverage-url]: https://codecov.io/gh/Esri/arcgis-rest-js
+
+# @esri/arcgis-rest-request
+
+> A module for making requests to the ArcGIS REST API that runs in Node.js and modern browsers.
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+```
+
+```js
+import { request } from "@esri/arcgis-rest-request";
+
+const url =
+  "https://www.arcgis.com/sharing/rest/content/items/6e03e8c26aad4b9c92a87c1063ddb0e3/data";
+
+request(url).then((response) => {
+  console.log(response); // WebMap JSON
+});
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/request/)
+
+### 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).
+
+### [Changelog](https://github.com/Esri/arcgis-rest-js/blob/master/CHANGELOG.md)
+
+### License
+
+Copyright &copy; 2017-2019 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-request/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@esri/arcgis-rest-request",
+  "version": "3.3.0",
+  "description": "Common methods and utilities for @esri/arcgis-rest-js packages.",
+  "license": "Apache-2.0",
+  "keywords": [
+    "ES6",
+    "arcgis",
+    "esri",
+    "fetch",
+    "promise",
+    "typescript"
+  ],
+  "type": "module",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "unpkg": "dist/bundled/request.umd.min.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "dist/esm/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist/**"
+  ],
+  "scripts": {
+    "build": "npm-run-all --parallel build:*",
+    "postbuild": "node ../../scripts/create-dist-package-jsons.js",
+    "build:bundled": "rollup -c ../../rollup.js",
+    "build:cjs": "tsc --outDir ./dist/cjs -m commonjs",
+    "build:esm": "tsc --outDir ./dist/esm --declaration",
+    "dev": "npm-run-all --parallel dev:*",
+    "dev:bundled": "rollup -w -c ../../rollup.js",
+    "dev:cjs": "tsc -w --outDir ./dist/cjs -m commonjs",
+    "dev:esm": "tsc -w --outDir ./dist/esm --declaration"
+  },
+  "engines": {
+    "node": ">=12.20.0"
+  },
+  "dependencies": {
+    "@esri/arcgis-rest-fetch": "3.3.0",
+    "@esri/arcgis-rest-form-data": "3.3.0",
+    "tslib": "^2.3.1"
+  },
+  "contributors": [
+    "Patrick Arlt <parlt@esri.com> (http://patrickarlt.com/)"
+  ],
+  "homepage": "https://github.com/Esri/arcgis-rest-js#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Esri/arcgis-rest-js.git",
+    "directory": "packages/arcgis-rest-request"
+  },
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "esri": {
+    "keyExports": [
+      "request"
+    ]
+  }
+}

package/packages/arcgis-rest-request/post-message-auth-spec.md

@@ -0,0 +1,70 @@
+# Post Message Authentication Specification
+
+The general idea is that the HOST application will only respond when the following conditions are true:
+
+- the event.origin is a location that the HOST trusts
+- the message type is `arcgis:auth:requestCredential`
+
+Under any other conditions, the HOST application will not send any response.
+
+## Message Types
+
+Messages send via `postMessage` can be any object, but by convention usually have a `type` property that describes what sort of message it is.
+
+| Type                            | Description                                                                                                        |
+| ------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| `arcgis:auth:requestCredential` | Request credential from host app. Request will be rejected if the `event.origin` is not in the `validOrigins` list |
+| `arcgis:auth:credential`        | Returning the credential in `event.credential`                                                                     |
+| `arcgis:auth:error`             | Returned if the host declines to send credentials. `event.message` will contain the reason                         |
+
+# Message Details
+
+## `arcgis:auth:requestCredential`
+
+Sent from an embedded app, to the parent.
+
+Message Object
+
+```json
+{
+  "type": "arcgis:auth:requestCredential"
+}
+```
+
+## `arcgis:auth:credential`
+
+Send from the host app to the embedded app.
+
+- Embedded application is responsible for calling `exchangeToken` or `validateAppAccess`
+
+Message Object
+
+```json
+{
+  "type": "arcgis:auth:credential",
+  "credential": {
+    "token": "thetoken",
+    "userId": "jsmith",
+    "server": "https://www.arcgis.com",
+    "ssl": true,
+    "expires": 1599831467093
+  }
+}
+```
+
+## `arcgis:auth:error`
+
+Sent from an host app, to an embedded app, with an error indicating why.
+This will only be sent if the HOST app has some issue getting the credential.
+
+Message Object
+
+```json
+{
+  "type": "arcgis:auth:error",
+  "error": {
+    "name": "<error name>",
+    "message": "<reason etc>"
+  }
+}
+```

package/packages/arcgis-rest-request/src/ApiKeyManager.ts

@@ -0,0 +1,60 @@
+/* Copyright (c) 2017-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IAuthenticationManager } from "./utils/IAuthenticationManager.js";
+
+/**
+ * Options for the `ApiKey` constructor.
+ */
+export interface IApiKeyOptions {
+  key: string;
+}
+
+/**
+ * Used to authenticate methods in ArcGIS REST JS with an API keys. The instance of `ApiKeyManager` can be passed to  {@linkcode IRequestOptions.authentication} to authenticate requests.
+ * 
+ * ```js
+ * import { ApiKeyManager } from '@esri/arcgis-rest-auth';
+ 
+ * const apiKey = new ApiKeyManager.fromKey("...");
+ * ```
+ * 
+ * In most cases however the API key can be passed directly to the {@linkcode IRequestOptions.authentication}.
+ */
+export class ApiKeyManager implements IAuthenticationManager {
+  /**
+   * The current portal the user is authenticated with.
+   */
+  public readonly portal: string = "https://www.arcgis.com/sharing/rest";
+
+  private key: string;
+
+  /**
+   * The preferred method for creating an instance of `ApiKeyManager`.
+   */
+  public static fromKey(apiKey: string) {
+    return new ApiKeyManager({ key: apiKey });
+  }
+
+  constructor(options: IApiKeyOptions) {
+    this.key = options.key;
+  }
+
+  /**
+   * Gets a token (the API Key).
+   */
+  public getToken(url: string) {
+    return Promise.resolve(this.key);
+  }
+}
+
+/**
+ * @deprecated - Use {@linkcode ApiKeyManager}.
+ */ /* istanbul ignore next */
+export function ApiKey(options: IApiKeyOptions) {
+  console.log(
+    "DEPRECATED:, 'ApiKey' is deprecated. Use 'ApiKeyManager' instead."
+  );
+
+  return new ApiKeyManager(options);
+}

package/packages/arcgis-rest-request/src/ApplicationCredentialsManager.ts

@@ -0,0 +1,141 @@
+/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IAuthenticationManager } from "./utils/IAuthenticationManager.js";
+import { ITokenRequestOptions } from "./utils/ITokenRequestOptions.js";
+import { fetchToken } from "./fetch-token.js";
+
+export interface IApplicationCredentialsManagerOptions {
+  /**
+   * Client ID of your application. Can be obtained by registering an application
+   * on [ArcGIS for Developers](https://developers.arcgis.com/documentation/core-concepts/security-and-authentication/signing-in-arcgis-online-users/#registering-your-application),
+   * [ArcGIS Online](http://doc.arcgis.com/en/arcgis-online/share-maps/add-items.htm#ESRI_SECTION1_0D1B620254F745AE84F394289F8AF44B) or on your instance of ArcGIS Enterprise.
+   */
+  clientId: string;
+
+  /**
+   * A Client Secret is also obtained by registering an application
+   * on [ArcGIS for Developers](https://developers.arcgis.com/documentation/core-concepts/security-and-authentication/signing-in-arcgis-online-users/#registering-your-application),
+   * [ArcGIS Online](http://doc.arcgis.com/en/arcgis-online/share-maps/add-items.htm#ESRI_SECTION1_0D1B620254F745AE84F394289F8AF44B) or on your instance of ArcGIS Enterprise. Treat it like a password.
+   */
+  clientSecret: string;
+
+  /**
+   * OAuth 2.0 access token from a previous application session.
+   */
+  token?: string;
+
+  /**
+   * Expiration date for the `token`
+   */
+  expires?: Date;
+
+  /**
+   * URL of ArcGIS REST base, defaults to "https://www.arcgis.com/sharing/rest"
+   */
+  portal?: string;
+
+  /**
+   * Duration of requested tokens in minutes. defaults to 7200 (5 days).
+   */
+  duration?: number;
+}
+
+/**
+ * Used to authenticate methods in ArcGIS REST JS with oAuth 2.0 application credentials. The instance of `ApplicationCredentialsManager` can be passed to  {@linkcode IRequestOptions.authentication} to authenticate requests.
+ * ```js
+ * import { ApplicationSession } from '@esri/arcgis-rest-auth';
+ *
+ * const session = ApplicationCredentialsManager.fromCredentials({
+ *   clientId: "abc123",
+ *   clientSecret: "••••••"
+ * })
+ * ```
+ */
+export class ApplicationCredentialsManager implements IAuthenticationManager {
+  public portal: string;
+  private clientId: string;
+  private clientSecret: string;
+  private token: string;
+  private expires: Date;
+  private duration: number;
+
+  /**
+   * Preferred method for creating an `ApplicationCredentialsManager`
+   */
+  public static fromCredentials(
+    options: IApplicationCredentialsManagerOptions
+  ) {
+    return new ApplicationCredentialsManager(options);
+  }
+
+  /**
+   * Internal object to keep track of pending token requests. Used to prevent
+   *  duplicate token requests.
+   */
+  private _pendingTokenRequest: Promise<string>;
+
+  constructor(options: IApplicationCredentialsManagerOptions) {
+    this.clientId = options.clientId;
+    this.clientSecret = options.clientSecret;
+    this.token = options.token;
+    this.expires = options.expires;
+    this.portal = options.portal || "https://www.arcgis.com/sharing/rest";
+    this.duration = options.duration || 7200;
+  }
+
+  // URL is not actually read or passed through.
+  public getToken(
+    url: string,
+    requestOptions?: ITokenRequestOptions
+  ): Promise<string> {
+    if (this.token && this.expires && this.expires.getTime() > Date.now()) {
+      return Promise.resolve(this.token);
+    }
+
+    if (this._pendingTokenRequest) {
+      return this._pendingTokenRequest;
+    }
+
+    this._pendingTokenRequest = this.refreshToken(requestOptions);
+
+    return this._pendingTokenRequest;
+  }
+
+  public refreshToken(requestOptions?: ITokenRequestOptions): Promise<string> {
+    const options = {
+      params: {
+        client_id: this.clientId,
+        client_secret: this.clientSecret,
+        grant_type: "client_credentials",
+        expiration: this.duration
+      },
+      ...requestOptions
+    };
+    return fetchToken(`${this.portal}/oauth2/token/`, options).then(
+      (response) => {
+        this._pendingTokenRequest = null;
+        this.token = response.token;
+        this.expires = response.expires;
+        return response.token;
+      }
+    );
+  }
+
+  public refreshSession() {
+    return this.refreshToken().then(() => this);
+  }
+}
+
+/**
+ * @deprecated - Use {@linkcode ApplicationCredentialsManager}.
+ */ /* istanbul ignore next */
+export function ApplicationSession(
+  options: IApplicationCredentialsManagerOptions
+) {
+  console.log(
+    "DEPRECATED:, 'ApplicationSession' is deprecated. Use 'ApplicationCredentialsManager' instead."
+  );
+
+  return new ApplicationCredentialsManager(options);
+}