autnam 1.0.0

package/packages/arcgis-rest-request/test/utils/process-params.test.ts

@@ -0,0 +1,205 @@
+/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { processParams, requiresFormData } from "../../src/index.js";
+
+describe("processParams", () => {
+  it("should pass non Date, Function, Array and Object params through", () => {
+    const params = {
+      foo: "foo",
+      bar: 1,
+    };
+
+    const expected = {
+      foo: "foo",
+      bar: 1,
+    };
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should encode Dates as timestamps", () => {
+    const date = new Date();
+
+    const params = {
+      foo: date,
+    };
+
+    const expected = {
+      foo: date.getTime(),
+    };
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should not encode a function", () => {
+    const params = {
+      foo() {}, // tslint:disable-line no-empty
+    };
+
+    expect(processParams(params)).toEqual({});
+  });
+
+  it("should stringify objects", () => {
+    const params = {
+      foo: {
+        bar: "bar",
+      },
+    };
+
+    const expected = {
+      foo: '{"bar":"bar"}',
+    };
+
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should stringify arrays of objects", () => {
+    const params = {
+      foo: [
+        {
+          bar: "bar",
+        },
+      ],
+    };
+
+    const expected = {
+      foo: '[{"bar":"bar"}]',
+    };
+
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should comma separate arrays of non objects", () => {
+    const params = {
+      foo: ["bar", "baz"],
+    };
+
+    const expected = {
+      foo: "bar,baz",
+    };
+
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should pass array of arrays through", () => {
+    const params = {
+      foo: [["bar1"], ["baz1", "baz2"]],
+    };
+
+    const expected = {
+      foo: [["bar1"], ["baz1", "baz2"]],
+    };
+
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should stringify booleans", () => {
+    const params = {
+      foo: true,
+      bar: false,
+    };
+
+    const expected = {
+      foo: "true",
+      bar: "false",
+    };
+
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should exclude null and undefined, but not a zero", () => {
+    const params: any = {
+      foo: null,
+      bar: undefined,
+      baz: 0,
+    };
+
+    const expected = {
+      baz: 0,
+    };
+
+    expect(processParams(params)).toEqual(expected);
+  });
+
+  it("should not require form data for simple requests", () => {
+    expect(
+      requiresFormData({
+        string: "string",
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        number: 123,
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        date: new Date(),
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        boolean: true,
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        array: [],
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        object: {},
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        fn: () => {
+          return;
+        },
+      })
+    ).toBeFalsy();
+
+    expect(
+      requiresFormData({
+        falsy: null,
+      })
+    ).toBeFalsy();
+  });
+
+  it("should require form data for multipart requests", () => {
+    const binaryObj =
+      typeof File !== "undefined"
+        ? new File(["foo"], "foo.txt", {
+            type: "text/plain",
+          })
+        : Buffer.from("");
+
+    expect(
+      requiresFormData({
+        binary: binaryObj,
+      })
+    ).toBeTruthy();
+  });
+
+  it("should require form data for mixed multipart requests", () => {
+    const binaryObj =
+      typeof File !== "undefined"
+        ? new File(["foo"], "foo.txt", {
+            type: "text/plain",
+          })
+        : Buffer.from("");
+
+    expect(
+      requiresFormData({
+        string: "string",
+        binary: binaryObj,
+      })
+    ).toBeTruthy();
+  });
+});

package/packages/arcgis-rest-request/test/utils/with-options.test.ts

@@ -0,0 +1,135 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request } from "../../src/request.js";
+import { IRequestOptions } from "../../src/utils/IRequestOptions.js";
+import { withOptions } from "../../src/utils/with-options.js";
+
+import fetchMock from "fetch-mock";
+
+const SharingRestInfo = {
+  owningSystemUrl: "http://www.arcgis.com",
+  authInfo: {
+    tokenServicesUrl: "https://www.arcgis.com/sharing/rest/generateToken",
+    isTokenBasedSecurity: true,
+  },
+};
+
+describe("withOptions()", () => {
+  afterEach(() => {
+    fetchMock.restore();
+  });
+
+  it("should wrap a basic request with default options", (done) => {
+    fetchMock.once("*", SharingRestInfo);
+    const requestWithOptions = withOptions(
+      {
+        headers: {
+          "Test-Header": "Test",
+        },
+      },
+      request
+    );
+
+    requestWithOptions("https://www.arcgis.com/sharing/rest/info")
+      .then(() => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual("https://www.arcgis.com/sharing/rest/info");
+        expect((options.headers as any)["Test-Header"]).toBe("Test");
+        done();
+      })
+      .catch((e: any) => {
+        fail(e);
+      });
+  });
+
+  it("should wrap a custom request implementation with default options", (done) => {
+    const MockResponse = {
+      test: "bar",
+    };
+
+    fetchMock.once("*", MockResponse);
+
+    interface ICustomOptions extends IRequestOptions {
+      id: string;
+    }
+
+    interface ICustomResponse {
+      test: string;
+    }
+
+    function customRequest(options: ICustomOptions): Promise<ICustomResponse> {
+      options.params = {
+        id: options.id,
+      };
+      return request("https://www.arcgis.com/sharing/rest/info", options);
+    }
+
+    const requestWithOptions = withOptions(
+      {
+        headers: {
+          "Test-Header": "Test",
+        },
+      },
+      customRequest
+    );
+
+    requestWithOptions({
+      id: "foo",
+    })
+      .then(() => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual("https://www.arcgis.com/sharing/rest/info");
+        expect(options.body).toContain("id=foo");
+        expect((options.headers as any)["Test-Header"]).toBe("Test");
+        done();
+      })
+      .catch((e: any) => {
+        fail(e);
+      });
+  });
+
+  it("should wrap a custom request implementation with multiple parameters with a default URL", (done) => {
+    const MockResponse = {
+      test: "bar",
+    };
+
+    fetchMock.once("*", MockResponse);
+
+    interface ICustomResponse {
+      test: string;
+    }
+
+    function customRequest(
+      id: string,
+      options: IRequestOptions = {}
+    ): Promise<ICustomResponse> {
+      options = {
+        ...options,
+        ...{ params: { ...options.params, ...{ id } } },
+      };
+      return request("https://www.arcgis.com/sharing/rest/info", options);
+    }
+
+    const requestWithOptions = withOptions(
+      {
+        headers: {
+          "Test-Header": "Test",
+        },
+      },
+      customRequest
+    );
+
+    requestWithOptions("foo")
+      .then(() => {
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual("https://www.arcgis.com/sharing/rest/info");
+        expect(options.body).toContain("id=foo");
+        expect((options.headers as any)["Test-Header"]).toBe("Test");
+        done();
+      })
+      .catch((e: any) => {
+        fail(e);
+      });
+  });
+});

package/packages/arcgis-rest-request/test/validate-app-access.test.ts

@@ -0,0 +1,44 @@
+/* Copyright (c) 2018-2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import fetchMock from "fetch-mock";
+import { validateAppAccess } from "../src/index.js";
+
+const VERIFYAPPACCESS_URL =
+  "https://www.arcgis.com/sharing/rest/oauth2/validateAppAccess";
+
+describe("validateAppAccess: ", () => {
+  it("makes a request to /oauth2/validateAppAccess passing params", () => {
+    fetchMock.postOnce(VERIFYAPPACCESS_URL, {
+      valid: true,
+      viewOnlyUserTypeApp: false
+    });
+    return validateAppAccess("FAKE-TOKEN", "abc123")
+      .then((response) => {
+        const [url, options]: [string, RequestInit] =
+          fetchMock.lastCall(VERIFYAPPACCESS_URL);
+        expect(url).toEqual(VERIFYAPPACCESS_URL);
+        expect(options.body).toContain("f=json");
+        expect(options.body).toContain("token=FAKE-TOKEN");
+        expect(options.body).toContain("client_id=abc123");
+        expect(response.valid).toEqual(true);
+        expect(response.viewOnlyUserTypeApp).toBe(false);
+      })
+      .catch((e) => fail(e));
+  });
+  it("takes a portalUrl", () => {
+    const PORTAL_BASE_URL = "https://my-portal.com/instance/sharing/rest";
+    const PORTAL_VERIFY_URL = `${PORTAL_BASE_URL}/oauth2/validateAppAccess`;
+    fetchMock.postOnce(PORTAL_VERIFY_URL, {
+      valid: true,
+      viewOnlyUserTypeApp: false
+    });
+    return validateAppAccess("FAKE-TOKEN", "abc123", PORTAL_BASE_URL)
+      .then((response) => {
+        const [url, options]: [string, RequestInit] =
+          fetchMock.lastCall(PORTAL_VERIFY_URL);
+        expect(url).toEqual(PORTAL_VERIFY_URL);
+      })
+      .catch((e) => fail(e));
+  });
+});

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

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

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

@@ -0,0 +1,74 @@
+[![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-routing.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-routing
+[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-routing/dist/bundled/routing.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-routing
+
+> Routing helpers for [`@esri/arcgis-rest-request`](https://github.com/Esri/arcgis-rest-js).
+
+### Example
+
+```bash
+npm install @esri/arcgis-rest-request
+npm install @esri/arcgis-rest-common
+npm install @esri/arcgis-rest-routing
+```
+
+```js
+solveRoute({
+  stops: [
+    [-117.195677, 34.056383],
+    [-117.918976, 33.812092]
+  ],
+  authentication
+}).then(response);
+// {routes: {features: [{attributes: { ... }, geometry:{ ... }}]}}
+```
+
+### [API Reference](https://esri.github.io/arcgis-rest-js/api/routing/)
+
+### 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; 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-routing/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@esri/arcgis-rest-routing",
+  "version": "3.3.0",
+  "description": "Routing helpers for @esri/arcgis-rest-js",
+  "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/routing.umd.min.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "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": {
+    "@terraformer/arcgis": "^2.0.7",
+    "@types/terraformer__arcgis": "^2.0.0",
+    "tslib": "^2.3.0"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-request": "^3.0.0"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-request": "^3.3.0"
+  },
+  "contributors": [
+    "Gavin Rehkemper <gavin@gavinr.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-routing"
+  },
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}