impeditmaiores 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- package/.prettierignore +2 -0
- package/.travis.yml +35 -0
- package/.vscode/launch.json +24 -0
- package/.vscode/settings.json +3 -0
- package/codecov.yml +7 -0
- package/demos/ago-node-cli/README.md +29 -0
- package/demos/ago-node-cli/ago.js +33 -0
- package/demos/ago-node-cli/index.js +11 -0
- package/demos/ago-node-cli/lib/item-export-command.js +48 -0
- package/demos/ago-node-cli/lib/item-search-command.js +35 -0
- package/demos/ago-node-cli/package-lock.json +152 -0
- package/demos/ago-node-cli/package.json +30 -0
- package/demos/attachments/README.md +5 -0
- package/demos/attachments/index.html +165 -0
- package/demos/attachments/package-lock.json +182 -0
- package/demos/attachments/package.json +18 -0
- package/demos/batch-geocoder-node/NYC_Restaurant_Inspection_Results.csv +100 -0
- package/demos/batch-geocoder-node/README.md +15 -0
- package/demos/batch-geocoder-node/batch-geocode.js +115 -0
- package/demos/batch-geocoder-node/config-template.js +18 -0
- package/demos/batch-geocoder-node/package-lock.json +81 -0
- package/demos/batch-geocoder-node/package.json +37 -0
- package/demos/express/README.md +15 -0
- package/demos/express/config.json.template +3 -0
- package/demos/express/package-lock.json +413 -0
- package/demos/express/package.json +18 -0
- package/demos/express/server.js +33 -0
- package/demos/feature-service-browser/README.md +6 -0
- package/demos/feature-service-browser/index.html +122 -0
- package/demos/feature-service-browser/package-lock.json +182 -0
- package/demos/feature-service-browser/package.json +18 -0
- package/demos/geocoder-browser/README.md +10 -0
- package/demos/geocoder-browser/config.js.template +1 -0
- package/demos/geocoder-browser/index.html +131 -0
- package/demos/geocoder-browser/package-lock.json +182 -0
- package/demos/geocoder-browser/package.json +19 -0
- package/demos/geocoder-browser/post-sign-in.html +25 -0
- package/demos/jsapi-integration/README.md +25 -0
- package/demos/jsapi-integration/config.js +6 -0
- package/demos/jsapi-integration/index.html +89 -0
- package/demos/jsapi-integration/package-lock.json +184 -0
- package/demos/jsapi-integration/package.json +19 -0
- package/demos/node-cli-item-management/README.md +10 -0
- package/demos/node-cli-item-management/index.js +238 -0
- package/demos/node-cli-item-management/package-lock.json +152 -0
- package/demos/node-cli-item-management/package.json +27 -0
- package/demos/node-cli-item-management/screenshot.png +0 -0
- package/demos/oauth2-browser/README.md +14 -0
- package/demos/oauth2-browser/authenticate.html +30 -0
- package/demos/oauth2-browser/config.js.template +6 -0
- package/demos/oauth2-browser/index.html +211 -0
- package/demos/oauth2-browser/logo.svg +4 -0
- package/demos/oauth2-browser/package-lock.json +224 -0
- package/demos/oauth2-browser/package.json +18 -0
- package/demos/oauth2-browser/style.css +36 -0
- package/demos/oauth2-browser-retry/README.md +25 -0
- package/demos/oauth2-browser-retry/authenticate.html +22 -0
- package/demos/oauth2-browser-retry/index.html +116 -0
- package/demos/oauth2-browser-retry/logo.svg +4 -0
- package/demos/stream-response-to-file/README.md +7 -0
- package/demos/stream-response-to-file/index.js +36 -0
- package/demos/stream-response-to-file/output/.gitkeep +0 -0
- package/demos/stream-response-to-file/package-lock.json +60 -0
- package/demos/stream-response-to-file/package.json +33 -0
- package/demos/tree-shaking-rollup/.babelrc +3 -0
- package/demos/tree-shaking-rollup/README.md +9 -0
- package/demos/tree-shaking-rollup/index.html +11 -0
- package/demos/tree-shaking-rollup/package-lock.json +2225 -0
- package/demos/tree-shaking-rollup/package.json +25 -0
- package/demos/tree-shaking-rollup/rollup.config.js +17 -0
- package/demos/tree-shaking-rollup/src/index.js +8 -0
- package/demos/tree-shaking-webpack/README.md +8 -0
- package/demos/tree-shaking-webpack/index.html +11 -0
- package/demos/tree-shaking-webpack/package-lock.json +4614 -0
- package/demos/tree-shaking-webpack/package.json +24 -0
- package/demos/tree-shaking-webpack/src/index.js +10 -0
- package/demos/tree-shaking-webpack/webpack.config.js +27 -0
- package/demos/vue/.env.example +11 -0
- package/demos/vue/.eslintrc.js +17 -0
- package/demos/vue/.postcssrc.js +5 -0
- package/demos/vue/README.md +17 -0
- package/demos/vue/babel.config.js +3 -0
- package/demos/vue/package-lock.json +11342 -0
- package/demos/vue/package.json +33 -0
- package/demos/vue/public/favicon.ico +0 -0
- package/demos/vue/public/index.html +24 -0
- package/demos/vue/src/assets/logo.svg +29 -0
- package/demos/vue/src/components/App.vue +305 -0
- package/demos/vue/src/components/Authenticate.vue +65 -0
- package/demos/vue/src/components/Loader.vue +230 -0
- package/demos/vue/src/main.js +92 -0
- package/demos/webmap-checker-sapper/.env.example +5 -0
- package/demos/webmap-checker-sapper/README.md +123 -0
- package/demos/webmap-checker-sapper/appveyor.yml +18 -0
- package/demos/webmap-checker-sapper/cypress/fixtures/example.json +5 -0
- package/demos/webmap-checker-sapper/cypress/integration/spec.js +19 -0
- package/demos/webmap-checker-sapper/cypress/plugins/index.js +17 -0
- package/demos/webmap-checker-sapper/cypress/support/commands.js +25 -0
- package/demos/webmap-checker-sapper/cypress/support/index.js +20 -0
- package/demos/webmap-checker-sapper/cypress.json +4 -0
- package/demos/webmap-checker-sapper/package-lock.json +3870 -0
- package/demos/webmap-checker-sapper/package.json +50 -0
- package/demos/webmap-checker-sapper/rollup.config.js +87 -0
- package/demos/webmap-checker-sapper/src/client.js +20 -0
- package/demos/webmap-checker-sapper/src/components/LayerStatus.html +108 -0
- package/demos/webmap-checker-sapper/src/components/Nav.html +21 -0
- package/demos/webmap-checker-sapper/src/components/WebMap.html +62 -0
- package/demos/webmap-checker-sapper/src/routes/_error.html +41 -0
- package/demos/webmap-checker-sapper/src/routes/_layout.html +21 -0
- package/demos/webmap-checker-sapper/src/routes/auth/authorize.js +18 -0
- package/demos/webmap-checker-sapper/src/routes/auth/exchange-token.js +20 -0
- package/demos/webmap-checker-sapper/src/routes/auth/post-sign-in.js +24 -0
- package/demos/webmap-checker-sapper/src/routes/auth/sign-out.js +10 -0
- package/demos/webmap-checker-sapper/src/routes/index.html +20 -0
- package/demos/webmap-checker-sapper/src/routes/webmaps/[webmapId].html +83 -0
- package/demos/webmap-checker-sapper/src/routes/webmaps/index.html +59 -0
- package/demos/webmap-checker-sapper/src/server.js +101 -0
- package/demos/webmap-checker-sapper/src/service-worker.js +82 -0
- package/demos/webmap-checker-sapper/src/template.html +33 -0
- package/demos/webmap-checker-sapper/src/userInfoMiddleware.js +21 -0
- package/demos/webmap-checker-sapper/src/utils.js +33 -0
- package/demos/webmap-checker-sapper/static/favicon.png +0 -0
- package/demos/webmap-checker-sapper/static/global.css +36 -0
- package/demos/webmap-checker-sapper/static/manifest.json +20 -0
- package/demos/webmap-checker-sapper/static/svelte-logo-192.png +0 -0
- package/demos/webmap-checker-sapper/static/svelte-logo-512.png +0 -0
- package/docs/FAQ.md +48 -0
- package/docs/HISTORY.md +62 -0
- package/docs/acetate.config.js +262 -0
- package/docs/build-typedoc.js +434 -0
- package/docs/generate-srihashes.js +53 -0
- package/docs/src/_layout.html +86 -0
- package/docs/src/api/_declaration.html +600 -0
- package/docs/src/api/_layout.html +204 -0
- package/docs/src/api/_package.html +38 -0
- package/docs/src/api/index.html +16 -0
- package/docs/src/guides/_layout.html +24 -0
- package/docs/src/guides/amd-requirejs-dojo.md +40 -0
- package/docs/src/guides/browser-authentication.md +41 -0
- package/docs/src/guides/bundlers.md +52 -0
- package/docs/src/guides/cli-authentication.md +9 -0
- package/docs/src/guides/client-server-authentication.md +9 -0
- package/docs/src/guides/embedded-apps.md +93 -0
- package/docs/src/guides/from-a-cdn.md +38 -0
- package/docs/src/guides/index.md +59 -0
- package/docs/src/guides/node.md +87 -0
- package/docs/src/guides/package-overview.md +111 -0
- package/docs/src/guides/server-authentication.md +9 -0
- package/docs/src/guides/whats-new-v2-0.md +305 -0
- package/docs/src/img/icons.png +0 -0
- package/docs/src/img/icons@2x.png +0 -0
- package/docs/src/index.html +12 -0
- package/docs/src/js/api-search.js +112 -0
- package/docs/src/js/nav-toggle.js +41 -0
- package/docs/src/sass/_highlight.scss +96 -0
- package/docs/src/sass/_icons.scss +157 -0
- package/docs/src/sass/style.scss +242 -0
- package/docs/src/srihashes.json +12 -0
- package/jasmine.json +7 -0
- package/karma.conf.js +106 -0
- package/lerna.json +8 -0
- package/notes/README.md +68 -0
- package/package.json +87 -0
- package/packages/arcgis-rest-auth/README.md +71 -0
- package/packages/arcgis-rest-auth/package-lock.json +11 -0
- package/packages/arcgis-rest-auth/package.json +69 -0
- package/packages/arcgis-rest-auth/src/ApplicationSession.ts +122 -0
- package/packages/arcgis-rest-auth/src/UserSession.ts +1206 -0
- package/packages/arcgis-rest-auth/src/app-tokens.ts +91 -0
- package/packages/arcgis-rest-auth/src/authenticated-request-options.ts +24 -0
- package/packages/arcgis-rest-auth/src/federation-utils.ts +85 -0
- package/packages/arcgis-rest-auth/src/fetch-token.ts +50 -0
- package/packages/arcgis-rest-auth/src/generate-token.ts +35 -0
- package/packages/arcgis-rest-auth/src/index.ts +9 -0
- package/packages/arcgis-rest-auth/src/validate-app-access.ts +68 -0
- package/packages/arcgis-rest-auth/test/ApplicationSession.test.ts +124 -0
- package/packages/arcgis-rest-auth/test/UserSession.test.ts +1807 -0
- package/packages/arcgis-rest-auth/test/app-tokens.test.ts +91 -0
- package/packages/arcgis-rest-auth/test/federation-utils.test.ts +323 -0
- package/packages/arcgis-rest-auth/test/fetchToken.test.ts +112 -0
- package/packages/arcgis-rest-auth/test/generateToken.test.ts +102 -0
- package/packages/arcgis-rest-auth/test/utils.ts +14 -0
- package/packages/arcgis-rest-auth/test/validate-app-access.test.ts +46 -0
- package/packages/arcgis-rest-auth/tsconfig.json +6 -0
- package/packages/arcgis-rest-feature-layer/README.md +77 -0
- package/packages/arcgis-rest-feature-layer/package-lock.json +11 -0
- package/packages/arcgis-rest-feature-layer/package.json +64 -0
- package/packages/arcgis-rest-feature-layer/src/add.ts +56 -0
- package/packages/arcgis-rest-feature-layer/src/addAttachment.ts +53 -0
- package/packages/arcgis-rest-feature-layer/src/applyEdits.ts +90 -0
- package/packages/arcgis-rest-feature-layer/src/decodeValues.ts +124 -0
- package/packages/arcgis-rest-feature-layer/src/delete.ts +61 -0
- package/packages/arcgis-rest-feature-layer/src/deleteAttachments.ts +52 -0
- package/packages/arcgis-rest-feature-layer/src/getAttachments.ts +55 -0
- package/packages/arcgis-rest-feature-layer/src/getLayer.ts +24 -0
- package/packages/arcgis-rest-feature-layer/src/getService.ts +26 -0
- package/packages/arcgis-rest-feature-layer/src/helpers.ts +79 -0
- package/packages/arcgis-rest-feature-layer/src/index.ts +31 -0
- package/packages/arcgis-rest-feature-layer/src/query.ts +204 -0
- package/packages/arcgis-rest-feature-layer/src/queryRelated.ts +89 -0
- package/packages/arcgis-rest-feature-layer/src/update.ts +56 -0
- package/packages/arcgis-rest-feature-layer/src/updateAttachment.ts +59 -0
- package/packages/arcgis-rest-feature-layer/test/attachments.test.ts +200 -0
- package/packages/arcgis-rest-feature-layer/test/crud.test.ts +195 -0
- package/packages/arcgis-rest-feature-layer/test/decodeValues.test.ts +67 -0
- package/packages/arcgis-rest-feature-layer/test/getLayer.test.ts +31 -0
- package/packages/arcgis-rest-feature-layer/test/getService.test.ts +31 -0
- package/packages/arcgis-rest-feature-layer/test/mocks/cvdQueryResponse.ts +225 -0
- package/packages/arcgis-rest-feature-layer/test/mocks/feature.ts +302 -0
- package/packages/arcgis-rest-feature-layer/test/mocks/fields.ts +779 -0
- package/packages/arcgis-rest-feature-layer/test/mocks/foo.txt +1 -0
- package/packages/arcgis-rest-feature-layer/test/mocks/service.ts +398 -0
- package/packages/arcgis-rest-feature-layer/test/query.test.ts +167 -0
- package/packages/arcgis-rest-feature-layer/tsconfig.json +6 -0
- package/packages/arcgis-rest-geocoding/README.md +86 -0
- package/packages/arcgis-rest-geocoding/package-lock.json +11 -0
- package/packages/arcgis-rest-geocoding/package.json +64 -0
- package/packages/arcgis-rest-geocoding/src/bulk.ts +104 -0
- package/packages/arcgis-rest-geocoding/src/geocode.ts +133 -0
- package/packages/arcgis-rest-geocoding/src/helpers.ts +54 -0
- package/packages/arcgis-rest-geocoding/src/index.ts +15 -0
- package/packages/arcgis-rest-geocoding/src/reverse.ts +84 -0
- package/packages/arcgis-rest-geocoding/src/suggest.ts +45 -0
- package/packages/arcgis-rest-geocoding/test/bulk.test.ts +194 -0
- package/packages/arcgis-rest-geocoding/test/geocode.test.ts +249 -0
- package/packages/arcgis-rest-geocoding/test/helpers.test.ts +85 -0
- package/packages/arcgis-rest-geocoding/test/mocks/responses.ts +637 -0
- package/packages/arcgis-rest-geocoding/test/reverse.test.ts +126 -0
- package/packages/arcgis-rest-geocoding/test/suggest.test.ts +53 -0
- package/packages/arcgis-rest-geocoding/tsconfig.json +6 -0
- package/packages/arcgis-rest-portal/README.md +73 -0
- package/packages/arcgis-rest-portal/package-lock.json +11 -0
- package/packages/arcgis-rest-portal/package.json +64 -0
- package/packages/arcgis-rest-portal/src/groups/add-users.ts +140 -0
- package/packages/arcgis-rest-portal/src/groups/create.ts +43 -0
- package/packages/arcgis-rest-portal/src/groups/get.ts +184 -0
- package/packages/arcgis-rest-portal/src/groups/helpers.ts +14 -0
- package/packages/arcgis-rest-portal/src/groups/invite-users.ts +127 -0
- package/packages/arcgis-rest-portal/src/groups/join.ts +57 -0
- package/packages/arcgis-rest-portal/src/groups/notification.ts +77 -0
- package/packages/arcgis-rest-portal/src/groups/protect.ts +56 -0
- package/packages/arcgis-rest-portal/src/groups/remove-users.ts +76 -0
- package/packages/arcgis-rest-portal/src/groups/remove.ts +32 -0
- package/packages/arcgis-rest-portal/src/groups/search.ts +47 -0
- package/packages/arcgis-rest-portal/src/groups/update-user-membership.ts +63 -0
- package/packages/arcgis-rest-portal/src/groups/update.ts +39 -0
- package/packages/arcgis-rest-portal/src/index.ts +66 -0
- package/packages/arcgis-rest-portal/src/items/add.ts +138 -0
- package/packages/arcgis-rest-portal/src/items/content.ts +67 -0
- package/packages/arcgis-rest-portal/src/items/create.ts +150 -0
- package/packages/arcgis-rest-portal/src/items/export.ts +80 -0
- package/packages/arcgis-rest-portal/src/items/get.ts +437 -0
- package/packages/arcgis-rest-portal/src/items/helpers.ts +275 -0
- package/packages/arcgis-rest-portal/src/items/protect.ts +41 -0
- package/packages/arcgis-rest-portal/src/items/reassign.ts +61 -0
- package/packages/arcgis-rest-portal/src/items/remove.ts +135 -0
- package/packages/arcgis-rest-portal/src/items/search.ts +25 -0
- package/packages/arcgis-rest-portal/src/items/update.ts +184 -0
- package/packages/arcgis-rest-portal/src/items/upload.ts +125 -0
- package/packages/arcgis-rest-portal/src/orgs/notification.ts +131 -0
- package/packages/arcgis-rest-portal/src/sharing/access.ts +84 -0
- package/packages/arcgis-rest-portal/src/sharing/helpers.ts +81 -0
- package/packages/arcgis-rest-portal/src/sharing/is-item-shared-with-group.ts +42 -0
- package/packages/arcgis-rest-portal/src/sharing/share-item-with-group.ts +319 -0
- package/packages/arcgis-rest-portal/src/sharing/unshare-item-with-group.ts +105 -0
- package/packages/arcgis-rest-portal/src/users/get-user-tags.ts +52 -0
- package/packages/arcgis-rest-portal/src/users/get-user-url.ts +18 -0
- package/packages/arcgis-rest-portal/src/users/get-user.ts +58 -0
- package/packages/arcgis-rest-portal/src/users/invitation.ts +156 -0
- package/packages/arcgis-rest-portal/src/users/notification.ts +68 -0
- package/packages/arcgis-rest-portal/src/users/search-users.ts +37 -0
- package/packages/arcgis-rest-portal/src/users/update.ts +66 -0
- package/packages/arcgis-rest-portal/src/util/SearchQueryBuilder.ts +374 -0
- package/packages/arcgis-rest-portal/src/util/array.ts +16 -0
- package/packages/arcgis-rest-portal/src/util/generic-search.ts +99 -0
- package/packages/arcgis-rest-portal/src/util/get-portal-settings.ts +45 -0
- package/packages/arcgis-rest-portal/src/util/get-portal-url.ts +27 -0
- package/packages/arcgis-rest-portal/src/util/get-portal.ts +52 -0
- package/packages/arcgis-rest-portal/src/util/get-subscription-info.ts +43 -0
- package/packages/arcgis-rest-portal/src/util/scrub-control-chars.ts +12 -0
- package/packages/arcgis-rest-portal/src/util/search.ts +42 -0
- package/packages/arcgis-rest-portal/test/groups/add-users.test.ts +239 -0
- package/packages/arcgis-rest-portal/test/groups/crud.test.ts +180 -0
- package/packages/arcgis-rest-portal/test/groups/get.test.ts +176 -0
- package/packages/arcgis-rest-portal/test/groups/invite-users.test.ts +149 -0
- package/packages/arcgis-rest-portal/test/groups/join.test.ts +72 -0
- package/packages/arcgis-rest-portal/test/groups/notification.test.ts +112 -0
- package/packages/arcgis-rest-portal/test/groups/protect.test.ts +72 -0
- package/packages/arcgis-rest-portal/test/groups/remove-users.test.ts +140 -0
- package/packages/arcgis-rest-portal/test/groups/search.test.ts +151 -0
- package/packages/arcgis-rest-portal/test/groups/update-user-membership.test.ts +62 -0
- package/packages/arcgis-rest-portal/test/items/add.test.ts +323 -0
- package/packages/arcgis-rest-portal/test/items/content.test.ts +156 -0
- package/packages/arcgis-rest-portal/test/items/create.test.ts +399 -0
- package/packages/arcgis-rest-portal/test/items/export.test.ts +122 -0
- package/packages/arcgis-rest-portal/test/items/get.test.ts +583 -0
- package/packages/arcgis-rest-portal/test/items/helpers.test.ts +60 -0
- package/packages/arcgis-rest-portal/test/items/protect.test.ts +122 -0
- package/packages/arcgis-rest-portal/test/items/reassign.test.ts +131 -0
- package/packages/arcgis-rest-portal/test/items/remove.test.ts +238 -0
- package/packages/arcgis-rest-portal/test/items/search.test.ts +272 -0
- package/packages/arcgis-rest-portal/test/items/update.test.ts +554 -0
- package/packages/arcgis-rest-portal/test/items/upload.test.ts +282 -0
- package/packages/arcgis-rest-portal/test/mocks/groups/responses.ts +208 -0
- package/packages/arcgis-rest-portal/test/mocks/items/foo.zip +0 -0
- package/packages/arcgis-rest-portal/test/mocks/items/item.ts +526 -0
- package/packages/arcgis-rest-portal/test/mocks/items/resources.ts +38 -0
- package/packages/arcgis-rest-portal/test/mocks/items/search.ts +121 -0
- package/packages/arcgis-rest-portal/test/mocks/portal/response.ts +126 -0
- package/packages/arcgis-rest-portal/test/mocks/portal/settings-response.ts +56 -0
- package/packages/arcgis-rest-portal/test/mocks/sharing/sharing.ts +18 -0
- package/packages/arcgis-rest-portal/test/mocks/users/invitation.ts +70 -0
- package/packages/arcgis-rest-portal/test/mocks/users/notification.ts +34 -0
- package/packages/arcgis-rest-portal/test/mocks/users/user-search.ts +388 -0
- package/packages/arcgis-rest-portal/test/mocks/users/user-tags.ts +5 -0
- package/packages/arcgis-rest-portal/test/mocks/users/user.ts +174 -0
- package/packages/arcgis-rest-portal/test/orgs/notification.test.ts +142 -0
- package/packages/arcgis-rest-portal/test/sharing/access.test.ts +162 -0
- package/packages/arcgis-rest-portal/test/sharing/helpers.test.ts +55 -0
- package/packages/arcgis-rest-portal/test/sharing/share-item-with-group.test.ts +1325 -0
- package/packages/arcgis-rest-portal/test/sharing/unshare-item-with-group.test.ts +288 -0
- package/packages/arcgis-rest-portal/test/users/get-user-tags.test.ts +71 -0
- package/packages/arcgis-rest-portal/test/users/get-user-url.test.ts +40 -0
- package/packages/arcgis-rest-portal/test/users/get-user.test.ts +90 -0
- package/packages/arcgis-rest-portal/test/users/invitation.test.ts +127 -0
- package/packages/arcgis-rest-portal/test/users/notification.test.ts +77 -0
- package/packages/arcgis-rest-portal/test/users/search.test.ts +42 -0
- package/packages/arcgis-rest-portal/test/users/update.test.ts +151 -0
- package/packages/arcgis-rest-portal/test/util/SearchQueryBuilder.test.ts +340 -0
- package/packages/arcgis-rest-portal/test/util/array.test.ts +30 -0
- package/packages/arcgis-rest-portal/test/util/get-portal-settings.test.ts +68 -0
- package/packages/arcgis-rest-portal/test/util/get-portal-url.test.ts +37 -0
- package/packages/arcgis-rest-portal/test/util/portal.test.ts +148 -0
- package/packages/arcgis-rest-portal/test/util/scrub-control-chars.test.ts +22 -0
- package/packages/arcgis-rest-portal/tsconfig.json +6 -0
- package/packages/arcgis-rest-request/README.md +72 -0
- package/packages/arcgis-rest-request/package-lock.json +11 -0
- package/packages/arcgis-rest-request/package.json +60 -0
- package/packages/arcgis-rest-request/src/index.ts +25 -0
- package/packages/arcgis-rest-request/src/request.ts +413 -0
- package/packages/arcgis-rest-request/src/utils/ArcGISRequestError.ts +76 -0
- package/packages/arcgis-rest-request/src/utils/ErrorTypes.ts +29 -0
- package/packages/arcgis-rest-request/src/utils/GrantTypes.ts +5 -0
- package/packages/arcgis-rest-request/src/utils/HTTPMethods.ts +6 -0
- package/packages/arcgis-rest-request/src/utils/IAuthenticationManager.ts +21 -0
- package/packages/arcgis-rest-request/src/utils/IFetchTokenParams.ts +11 -0
- package/packages/arcgis-rest-request/src/utils/IGenerateTokenParams.ts +9 -0
- package/packages/arcgis-rest-request/src/utils/IParamBuilder.ts +3 -0
- package/packages/arcgis-rest-request/src/utils/IParams.ts +6 -0
- package/packages/arcgis-rest-request/src/utils/IParamsBuilder.ts +5 -0
- package/packages/arcgis-rest-request/src/utils/IRequestOptions.ts +49 -0
- package/packages/arcgis-rest-request/src/utils/ITokenRequestOptions.ts +9 -0
- package/packages/arcgis-rest-request/src/utils/ResponseFormats.ts +10 -0
- package/packages/arcgis-rest-request/src/utils/append-custom-params.ts +49 -0
- package/packages/arcgis-rest-request/src/utils/clean-url.ts +20 -0
- package/packages/arcgis-rest-request/src/utils/decode-query-string.ts +27 -0
- package/packages/arcgis-rest-request/src/utils/encode-form-data.ts +38 -0
- package/packages/arcgis-rest-request/src/utils/encode-query-string.ts +35 -0
- package/packages/arcgis-rest-request/src/utils/process-params.ts +108 -0
- package/packages/arcgis-rest-request/src/utils/retryAuthError.ts +10 -0
- package/packages/arcgis-rest-request/src/utils/warn.ts +11 -0
- package/packages/arcgis-rest-request/src/utils/with-options.ts +48 -0
- package/packages/arcgis-rest-request/test/mocks/errors.ts +76 -0
- package/packages/arcgis-rest-request/test/mocks/geojson-feature-collection.ts +13 -0
- package/packages/arcgis-rest-request/test/mocks/param-builder.ts +7 -0
- package/packages/arcgis-rest-request/test/mocks/sharing-rest-info.ts +41 -0
- package/packages/arcgis-rest-request/test/mocks/webmap.ts +41 -0
- package/packages/arcgis-rest-request/test/request.test.ts +571 -0
- package/packages/arcgis-rest-request/test/utils/ArcGISAuthError.test.ts +191 -0
- package/packages/arcgis-rest-request/test/utils/ArcGISRequestError.test.ts +51 -0
- package/packages/arcgis-rest-request/test/utils/check-for-errors.test.ts +111 -0
- package/packages/arcgis-rest-request/test/utils/clean-url.test.ts +50 -0
- package/packages/arcgis-rest-request/test/utils/encode-form-data.test.ts +133 -0
- package/packages/arcgis-rest-request/test/utils/encode-query-string.test.ts +18 -0
- package/packages/arcgis-rest-request/test/utils/process-params.test.ts +205 -0
- package/packages/arcgis-rest-request/test/utils/with-options.test.ts +133 -0
- package/packages/arcgis-rest-request/tsconfig.json +4 -0
- package/packages/arcgis-rest-routing/README.md +75 -0
- package/packages/arcgis-rest-routing/package-lock.json +11 -0
- package/packages/arcgis-rest-routing/package.json +63 -0
- package/packages/arcgis-rest-routing/src/helpers.ts +16 -0
- package/packages/arcgis-rest-routing/src/index.ts +11 -0
- package/packages/arcgis-rest-routing/src/solveRoute.ts +124 -0
- package/packages/arcgis-rest-routing/test/mocks/responses.ts +825 -0
- package/packages/arcgis-rest-routing/test/solveRoute.test.ts +509 -0
- package/packages/arcgis-rest-routing/tsconfig.json +6 -0
- package/packages/arcgis-rest-service-admin/README.md +73 -0
- package/packages/arcgis-rest-service-admin/package-lock.json +11 -0
- package/packages/arcgis-rest-service-admin/package.json +65 -0
- package/packages/arcgis-rest-service-admin/src/addTo.ts +70 -0
- package/packages/arcgis-rest-service-admin/src/create.ts +189 -0
- package/packages/arcgis-rest-service-admin/src/index.ts +11 -0
- package/packages/arcgis-rest-service-admin/src/update.ts +50 -0
- package/packages/arcgis-rest-service-admin/test/addTo.test.ts +350 -0
- package/packages/arcgis-rest-service-admin/test/create.test.ts +294 -0
- package/packages/arcgis-rest-service-admin/test/mocks/layerDefinition.ts +79 -0
- package/packages/arcgis-rest-service-admin/test/mocks/service.ts +81 -0
- package/packages/arcgis-rest-service-admin/test/update.test.ts +115 -0
- package/packages/arcgis-rest-service-admin/tsconfig.json +6 -0
- package/packages/arcgis-rest-types/README.md +66 -0
- package/packages/arcgis-rest-types/package.json +54 -0
- package/packages/arcgis-rest-types/src/feature.ts +39 -0
- package/packages/arcgis-rest-types/src/geometry.ts +272 -0
- package/packages/arcgis-rest-types/src/group.ts +72 -0
- package/packages/arcgis-rest-types/src/index.ts +9 -0
- package/packages/arcgis-rest-types/src/item.ts +81 -0
- package/packages/arcgis-rest-types/src/service.ts +114 -0
- package/packages/arcgis-rest-types/src/statisticDefinition.ts +33 -0
- package/packages/arcgis-rest-types/src/symbol.ts +170 -0
- package/packages/arcgis-rest-types/src/user.ts +49 -0
- package/packages/arcgis-rest-types/src/webmap.ts +1367 -0
- package/packages/arcgis-rest-types/tsconfig.json +10 -0
- package/support/changelog.js +393 -0
- package/support/deploy-doc-site.js +16 -0
- package/support/dev.sh +6 -0
- package/support/publish.sh +47 -0
- package/support/test-helpers.js +9 -0
- package/tsconfig.json +63 -0
- package/tslint.json +16 -0
- package/umd-base-profile.js +81 -0
- package/umd-production-profile.js +13 -0
@@ -0,0 +1,64 @@
|
|
1
|
+
{
|
2
|
+
"name": "@esri/arcgis-rest-geocoding",
|
3
|
+
"version": "2.22.0",
|
4
|
+
"description": "Geocoding helpers for @esri/arcgis-rest-js",
|
5
|
+
"main": "dist/node/index.js",
|
6
|
+
"unpkg": "dist/umd/geocoding.umd.js",
|
7
|
+
"module": "dist/esm/index.js",
|
8
|
+
"js:next": "dist/esm/index.js",
|
9
|
+
"sideEffects": false,
|
10
|
+
"types": "dist/esm/index.d.ts",
|
11
|
+
"license": "Apache-2.0",
|
12
|
+
"files": [
|
13
|
+
"dist/**"
|
14
|
+
],
|
15
|
+
"dependencies": {
|
16
|
+
"@esri/arcgis-rest-types": "^2.22.0",
|
17
|
+
"tslib": "^1.13.0"
|
18
|
+
},
|
19
|
+
"devDependencies": {
|
20
|
+
"@esri/arcgis-rest-auth": "^2.22.0",
|
21
|
+
"@esri/arcgis-rest-request": "^2.22.0"
|
22
|
+
},
|
23
|
+
"peerDependencies": {
|
24
|
+
"@esri/arcgis-rest-auth": "^2.0.0",
|
25
|
+
"@esri/arcgis-rest-request": "^2.0.0"
|
26
|
+
},
|
27
|
+
"scripts": {
|
28
|
+
"prepare": "npm run build",
|
29
|
+
"build": "npm run build:node && npm run build:umd && npm run build:esm",
|
30
|
+
"build:esm": "tsc --module es2015 --outDir ./dist/esm --declaration",
|
31
|
+
"build:umd": "rollup -c ../../umd-base-profile.js && rollup -c ../../umd-production-profile.js",
|
32
|
+
"build:node": "tsc --module commonjs --outDir ./dist/node",
|
33
|
+
"dev:esm": "tsc -w --module es2015 --outDir ./dist/esm --declaration",
|
34
|
+
"dev:umd": "rollup -w -c ../../umd-base-profile.js",
|
35
|
+
"dev:node": "tsc -w --module commonjs --outDir ./dist/node"
|
36
|
+
},
|
37
|
+
"publishConfig": {
|
38
|
+
"access": "public"
|
39
|
+
},
|
40
|
+
"repository": {
|
41
|
+
"type": "git",
|
42
|
+
"url": "git+https://github.com/Esri/arcgis-rest-js.git",
|
43
|
+
"directory": "packages/arcgis-rest-geocoding"
|
44
|
+
},
|
45
|
+
"contributors": [
|
46
|
+
{
|
47
|
+
"name": "Patrick Arlt",
|
48
|
+
"email": "parlt@esri.com",
|
49
|
+
"url": "http://patrickarlt.com/"
|
50
|
+
}
|
51
|
+
],
|
52
|
+
"bugs": {
|
53
|
+
"url": "https://github.com/Esri/arcgis-rest-js/issues"
|
54
|
+
},
|
55
|
+
"homepage": "https://github.com/Esri/arcgis-rest-js#readme",
|
56
|
+
"keywords": [
|
57
|
+
"typescript",
|
58
|
+
"promise",
|
59
|
+
"fetch",
|
60
|
+
"arcgis",
|
61
|
+
"esri",
|
62
|
+
"ES6"
|
63
|
+
]
|
64
|
+
}
|
@@ -0,0 +1,104 @@
|
|
1
|
+
/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
|
2
|
+
* Apache-2.0 */
|
3
|
+
|
4
|
+
import { request, cleanUrl } from "@esri/arcgis-rest-request";
|
5
|
+
import { ISpatialReference, IPoint } from "@esri/arcgis-rest-types";
|
6
|
+
|
7
|
+
import { ARCGIS_ONLINE_GEOCODING_URL, IEndpointOptions } from "./helpers";
|
8
|
+
|
9
|
+
// it'd be better if doc didnt display these properties in alphabetical order
|
10
|
+
export interface IAddressBulk {
|
11
|
+
/**
|
12
|
+
* A unique id must be passed along for each individual address.
|
13
|
+
*/
|
14
|
+
OBJECTID: number;
|
15
|
+
address?: string;
|
16
|
+
address2?: string;
|
17
|
+
address3?: string;
|
18
|
+
neighborhood?: string;
|
19
|
+
city?: string;
|
20
|
+
subregion?: string;
|
21
|
+
/**
|
22
|
+
* The World Geocoding Service considers US states regions.
|
23
|
+
*/
|
24
|
+
region?: string;
|
25
|
+
postal?: number;
|
26
|
+
postalExt?: number;
|
27
|
+
countryCode?: string;
|
28
|
+
}
|
29
|
+
|
30
|
+
export interface IBulkGeocodeOptions extends IEndpointOptions {
|
31
|
+
addresses: IAddressBulk[];
|
32
|
+
}
|
33
|
+
|
34
|
+
export interface IBulkGeocodeResponse {
|
35
|
+
spatialReference: ISpatialReference;
|
36
|
+
locations: Array<{
|
37
|
+
address: string;
|
38
|
+
location?: IPoint; // candidates with a score of 0 wont include a location
|
39
|
+
score: number;
|
40
|
+
attributes: object;
|
41
|
+
}>;
|
42
|
+
}
|
43
|
+
|
44
|
+
/**
|
45
|
+
* ```js
|
46
|
+
* import { bulkGeocode } from '@esri/arcgis-rest-geocoding';
|
47
|
+
* import { ApplicationSession } from '@esri/arcgis-rest-auth';
|
48
|
+
* //
|
49
|
+
* const addresses = [
|
50
|
+
* { "OBJECTID": 1, "SingleLine": "380 New York Street 92373" },
|
51
|
+
* { "OBJECTID": 2, "SingleLine": "1 World Way Los Angeles 90045" }
|
52
|
+
* ];
|
53
|
+
* //
|
54
|
+
* bulkGeocode({ addresses, authentication: session })
|
55
|
+
* .then((response) => {
|
56
|
+
* response.locations[0].location; // => { x: -117, y: 34, spatialReference: { wkid: 4326 } }
|
57
|
+
* });
|
58
|
+
* ```
|
59
|
+
* Used to geocode a [batch](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-geocode-addresses.htm) of addresses.
|
60
|
+
*
|
61
|
+
* @param requestOptions - Request options to pass to the geocoder, including an array of addresses and authentication session.
|
62
|
+
* @returns A Promise that will resolve with the data from the response. The spatial reference will be added to address locations unless `rawResponse: true` was passed.
|
63
|
+
*/
|
64
|
+
export function bulkGeocode(
|
65
|
+
requestOptions: IBulkGeocodeOptions // must POST, which is the default
|
66
|
+
): Promise<IBulkGeocodeResponse> {
|
67
|
+
const options: IBulkGeocodeOptions = {
|
68
|
+
endpoint: ARCGIS_ONLINE_GEOCODING_URL,
|
69
|
+
params: {},
|
70
|
+
...requestOptions
|
71
|
+
};
|
72
|
+
|
73
|
+
options.params.addresses = {
|
74
|
+
records: requestOptions.addresses.map(address => {
|
75
|
+
return { attributes: address };
|
76
|
+
})
|
77
|
+
};
|
78
|
+
|
79
|
+
// the SAS service doesnt support anonymous requests
|
80
|
+
if (
|
81
|
+
!requestOptions.authentication &&
|
82
|
+
options.endpoint === ARCGIS_ONLINE_GEOCODING_URL
|
83
|
+
) {
|
84
|
+
return Promise.reject(
|
85
|
+
"bulk geocoding using the ArcGIS service requires authentication"
|
86
|
+
);
|
87
|
+
}
|
88
|
+
|
89
|
+
return request(
|
90
|
+
`${cleanUrl(options.endpoint)}/geocodeAddresses`,
|
91
|
+
options
|
92
|
+
).then(response => {
|
93
|
+
if (options.rawResponse) {
|
94
|
+
return response;
|
95
|
+
}
|
96
|
+
const sr = response.spatialReference;
|
97
|
+
response.locations.forEach(function(address: { location: IPoint }) {
|
98
|
+
if (address.location) {
|
99
|
+
address.location.spatialReference = sr;
|
100
|
+
}
|
101
|
+
});
|
102
|
+
return response;
|
103
|
+
});
|
104
|
+
}
|
@@ -0,0 +1,133 @@
|
|
1
|
+
/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
|
2
|
+
* Apache-2.0 */
|
3
|
+
|
4
|
+
import {
|
5
|
+
request,
|
6
|
+
cleanUrl,
|
7
|
+
appendCustomParams
|
8
|
+
} from "@esri/arcgis-rest-request";
|
9
|
+
|
10
|
+
import { IExtent, ISpatialReference, IPoint } from "@esri/arcgis-rest-types";
|
11
|
+
|
12
|
+
import { ARCGIS_ONLINE_GEOCODING_URL, IEndpointOptions } from "./helpers";
|
13
|
+
|
14
|
+
export interface IGeocodeOptions extends IEndpointOptions {
|
15
|
+
/**
|
16
|
+
* use this if all your address info is contained in a single string.
|
17
|
+
*/
|
18
|
+
singleLine?: string;
|
19
|
+
address?: string;
|
20
|
+
address2?: string;
|
21
|
+
address3?: string;
|
22
|
+
neighborhood?: string;
|
23
|
+
city?: string;
|
24
|
+
subregion?: string;
|
25
|
+
outFields?: "*" | string[];
|
26
|
+
/**
|
27
|
+
* The World Geocoding Service expects US states to be passed in as a 'region'.
|
28
|
+
*/
|
29
|
+
region?: string;
|
30
|
+
postal?: number;
|
31
|
+
postalExt?: number;
|
32
|
+
countryCode?: string;
|
33
|
+
/**
|
34
|
+
* You can create an autocomplete experience by making a call to suggest with partial text and then passing through the magicKey and complete address that are returned to geocode.
|
35
|
+
* ```js
|
36
|
+
* import { suggest, geocode } from '@esri/arcgis-rest-geocoding';
|
37
|
+
* suggest("LAX")
|
38
|
+
* .then((response) => {
|
39
|
+
* geocode({
|
40
|
+
* singleLine: response.suggestions[1].text,
|
41
|
+
* magicKey: response.suggestions[0].magicKey
|
42
|
+
* })
|
43
|
+
* })
|
44
|
+
* ```
|
45
|
+
*/
|
46
|
+
magicKey?: string;
|
47
|
+
}
|
48
|
+
|
49
|
+
export interface IGeocodeResponse {
|
50
|
+
spatialReference: ISpatialReference;
|
51
|
+
candidates: Array<{
|
52
|
+
address: string;
|
53
|
+
location: IPoint;
|
54
|
+
extent?: IExtent;
|
55
|
+
score: number;
|
56
|
+
attributes: object;
|
57
|
+
}>;
|
58
|
+
}
|
59
|
+
|
60
|
+
/**
|
61
|
+
* ```js
|
62
|
+
* import { geocode } from '@esri/arcgis-rest-geocoding';
|
63
|
+
* //
|
64
|
+
* geocode("LAX")
|
65
|
+
* .then((response) => {
|
66
|
+
* response.candidates[0].location; // => { x: -118.409, y: 33.943, spatialReference: ... }
|
67
|
+
* });
|
68
|
+
* //
|
69
|
+
* geocode({
|
70
|
+
* address: "1600 Pennsylvania Ave",
|
71
|
+
* postal: 20500,
|
72
|
+
* countryCode: "USA"
|
73
|
+
* })
|
74
|
+
* .then((response) => {
|
75
|
+
* response.candidates[1].location; // => { x: -77.036533, y: 38.898719, spatialReference: ... }
|
76
|
+
* });
|
77
|
+
* ```
|
78
|
+
* Used to determine the location of a single address or point of interest. See the [REST Documentation](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm) for more information.
|
79
|
+
* @param address String representing the address or point of interest or RequestOptions to pass to the endpoint.
|
80
|
+
* @returns A Promise that will resolve with address candidates for the request. The spatial reference will be added to candidate locations and extents unless `rawResponse: true` was passed.
|
81
|
+
*/
|
82
|
+
export function geocode(
|
83
|
+
address: string | IGeocodeOptions
|
84
|
+
): Promise<IGeocodeResponse> {
|
85
|
+
let options: IGeocodeOptions = {};
|
86
|
+
let endpoint: string;
|
87
|
+
|
88
|
+
if (typeof address === "string") {
|
89
|
+
options.params = { singleLine: address };
|
90
|
+
endpoint = ARCGIS_ONLINE_GEOCODING_URL;
|
91
|
+
} else {
|
92
|
+
endpoint = address.endpoint || ARCGIS_ONLINE_GEOCODING_URL;
|
93
|
+
options = appendCustomParams<IGeocodeOptions>(
|
94
|
+
address,
|
95
|
+
[
|
96
|
+
"singleLine",
|
97
|
+
"address",
|
98
|
+
"address2",
|
99
|
+
"address3",
|
100
|
+
"neighborhood",
|
101
|
+
"city",
|
102
|
+
"subregion",
|
103
|
+
"region",
|
104
|
+
"postal",
|
105
|
+
"postalExt",
|
106
|
+
"countryCode",
|
107
|
+
"outFields",
|
108
|
+
"magicKey"
|
109
|
+
],
|
110
|
+
{ params: { ...address.params } }
|
111
|
+
);
|
112
|
+
}
|
113
|
+
|
114
|
+
// add spatialReference property to individual matches
|
115
|
+
return request(`${cleanUrl(endpoint)}/findAddressCandidates`, options).then(
|
116
|
+
response => {
|
117
|
+
if (typeof address !== "string" && address.rawResponse) {
|
118
|
+
return response;
|
119
|
+
}
|
120
|
+
const sr = response.spatialReference;
|
121
|
+
response.candidates.forEach(function(candidate: {
|
122
|
+
location: IPoint;
|
123
|
+
extent?: IExtent;
|
124
|
+
}) {
|
125
|
+
candidate.location.spatialReference = sr;
|
126
|
+
if (candidate.extent) {
|
127
|
+
candidate.extent.spatialReference = sr;
|
128
|
+
}
|
129
|
+
});
|
130
|
+
return response;
|
131
|
+
}
|
132
|
+
);
|
133
|
+
}
|
@@ -0,0 +1,54 @@
|
|
1
|
+
/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
|
2
|
+
* Apache-2.0 */
|
3
|
+
|
4
|
+
import { request, IRequestOptions } from "@esri/arcgis-rest-request";
|
5
|
+
|
6
|
+
// https always
|
7
|
+
export const ARCGIS_ONLINE_GEOCODING_URL =
|
8
|
+
"https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/";
|
9
|
+
|
10
|
+
// nice to have: verify custom endpoints contain 'GeocodeServer' and end in a '/'
|
11
|
+
export interface IEndpointOptions extends IRequestOptions {
|
12
|
+
/**
|
13
|
+
* Any ArcGIS Geocoding service (example: http://sampleserver6.arcgisonline.com/arcgis/rest/services/Locators/SanDiego/GeocodeServer )
|
14
|
+
*/
|
15
|
+
endpoint?: string;
|
16
|
+
}
|
17
|
+
|
18
|
+
export interface IGetGeocodeServiceResponse {
|
19
|
+
currentVersion: number;
|
20
|
+
serviceDescription: string;
|
21
|
+
addressFields: any[];
|
22
|
+
countries: string[];
|
23
|
+
capabilities: string;
|
24
|
+
}
|
25
|
+
|
26
|
+
/**
|
27
|
+
* Used to fetch metadata from a geocoding service.
|
28
|
+
*
|
29
|
+
* ```js
|
30
|
+
* import { getGeocoderServiceInfo } from '@esri/arcgis-rest-geocoding';
|
31
|
+
*
|
32
|
+
* getGeocoderServiceInfo()
|
33
|
+
* .then((response) => {
|
34
|
+
* response.serviceDescription; // => 'World Geocoder'
|
35
|
+
* });
|
36
|
+
* ```
|
37
|
+
*
|
38
|
+
* @param requestOptions - Request options can contain a custom geocoding service to fetch metadata from.
|
39
|
+
* @returns A Promise that will resolve with the data from the response.
|
40
|
+
*/
|
41
|
+
export function getGeocodeService(
|
42
|
+
requestOptions?: IEndpointOptions
|
43
|
+
): Promise<IGetGeocodeServiceResponse> {
|
44
|
+
const url =
|
45
|
+
(requestOptions && requestOptions.endpoint) || ARCGIS_ONLINE_GEOCODING_URL;
|
46
|
+
|
47
|
+
const options: IEndpointOptions = {
|
48
|
+
httpMethod: "GET",
|
49
|
+
maxUrlLength: 2000,
|
50
|
+
...requestOptions
|
51
|
+
};
|
52
|
+
|
53
|
+
return request(url, options);
|
54
|
+
}
|
@@ -0,0 +1,15 @@
|
|
1
|
+
/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
|
2
|
+
* Apache-2.0 */
|
3
|
+
|
4
|
+
export * from "./geocode";
|
5
|
+
export * from "./suggest";
|
6
|
+
export * from "./reverse";
|
7
|
+
export * from "./bulk";
|
8
|
+
export * from "./helpers";
|
9
|
+
|
10
|
+
export {
|
11
|
+
IPoint,
|
12
|
+
ILocation,
|
13
|
+
IExtent,
|
14
|
+
ISpatialReference
|
15
|
+
} from "@esri/arcgis-rest-types";
|
@@ -0,0 +1,84 @@
|
|
1
|
+
/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
|
2
|
+
* Apache-2.0 */
|
3
|
+
|
4
|
+
import { request, cleanUrl } from "@esri/arcgis-rest-request";
|
5
|
+
|
6
|
+
import { IPoint, ILocation } from "@esri/arcgis-rest-types";
|
7
|
+
|
8
|
+
import { ARCGIS_ONLINE_GEOCODING_URL, IEndpointOptions } from "./helpers";
|
9
|
+
|
10
|
+
export interface IReverseGeocodeResponse {
|
11
|
+
address: {
|
12
|
+
[key: string]: any;
|
13
|
+
};
|
14
|
+
location: IPoint;
|
15
|
+
}
|
16
|
+
|
17
|
+
function isLocationArray(
|
18
|
+
coords: ILocation | IPoint | [number, number] | [number, number, number]
|
19
|
+
): coords is [number, number] | [number, number, number] {
|
20
|
+
return (
|
21
|
+
(coords as [number, number]).length === 2 ||
|
22
|
+
(coords as [number, number, number]).length === 3
|
23
|
+
);
|
24
|
+
}
|
25
|
+
|
26
|
+
function isLocation(
|
27
|
+
coords: ILocation | IPoint | [number, number] | [number, number, number]
|
28
|
+
): coords is ILocation {
|
29
|
+
return (
|
30
|
+
(coords as ILocation).latitude !== undefined ||
|
31
|
+
(coords as ILocation).lat !== undefined
|
32
|
+
);
|
33
|
+
}
|
34
|
+
|
35
|
+
/**
|
36
|
+
* ```js
|
37
|
+
* import { reverseGeocode } from '@esri/arcgis-rest-geocoding';
|
38
|
+
* //
|
39
|
+
* reverseGeocode([-118.409,33.943 ]) // long, lat
|
40
|
+
* .then((response) => {
|
41
|
+
* response.address.PlaceName; // => "LA Airport"
|
42
|
+
* });
|
43
|
+
* // or
|
44
|
+
* reverseGeocode({ long: -118.409, lat: 33.943 })
|
45
|
+
* reverseGeocode({ latitude: 33.943, latitude: -118.409 })
|
46
|
+
* reverseGeocode({ x: -118.409, y: 33.9425 }) // wgs84 is assumed
|
47
|
+
* reverseGeocode({ x: -13181226, y: 4021085, spatialReference: { wkid: 3857 })
|
48
|
+
* ```
|
49
|
+
* Used to determine the address of a [location](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-reverse-geocode.htm).
|
50
|
+
*
|
51
|
+
* @param coordinates - the location you'd like to associate an address with.
|
52
|
+
* @param requestOptions - Additional options for the request including authentication.
|
53
|
+
* @returns A Promise that will resolve with the data from the response.
|
54
|
+
*/
|
55
|
+
export function reverseGeocode(
|
56
|
+
coords: IPoint | ILocation | [number, number],
|
57
|
+
requestOptions?: IEndpointOptions
|
58
|
+
): Promise<IReverseGeocodeResponse> {
|
59
|
+
const options: IEndpointOptions = {
|
60
|
+
endpoint: ARCGIS_ONLINE_GEOCODING_URL,
|
61
|
+
params: {},
|
62
|
+
...requestOptions
|
63
|
+
};
|
64
|
+
|
65
|
+
if (isLocationArray(coords)) {
|
66
|
+
options.params.location = coords.join();
|
67
|
+
} else if (isLocation(coords)) {
|
68
|
+
if (coords.lat) {
|
69
|
+
options.params.location = coords.long + "," + coords.lat;
|
70
|
+
}
|
71
|
+
if (coords.latitude) {
|
72
|
+
options.params.location = coords.longitude + "," + coords.latitude;
|
73
|
+
}
|
74
|
+
} else {
|
75
|
+
// if input is a point, we can pass it straight through, with or without a spatial reference
|
76
|
+
options.params.location = coords;
|
77
|
+
}
|
78
|
+
|
79
|
+
return request(`${cleanUrl(options.endpoint)}/reverseGeocode`, options);
|
80
|
+
}
|
81
|
+
|
82
|
+
export default {
|
83
|
+
reverseGeocode
|
84
|
+
};
|
@@ -0,0 +1,45 @@
|
|
1
|
+
/* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
|
2
|
+
* Apache-2.0 */
|
3
|
+
|
4
|
+
import { request, cleanUrl } from "@esri/arcgis-rest-request";
|
5
|
+
|
6
|
+
import { ARCGIS_ONLINE_GEOCODING_URL, IEndpointOptions } from "./helpers";
|
7
|
+
|
8
|
+
export interface ISuggestResponse {
|
9
|
+
suggestions: Array<{
|
10
|
+
text: string;
|
11
|
+
magicKey: string;
|
12
|
+
isCollection: boolean;
|
13
|
+
}>;
|
14
|
+
}
|
15
|
+
|
16
|
+
/**
|
17
|
+
* ```js
|
18
|
+
* import { suggest } from '@esri/arcgis-rest-geocoding';
|
19
|
+
* //
|
20
|
+
* suggest("Starb")
|
21
|
+
* .then(response) // response.text === "Starbucks"
|
22
|
+
* ```
|
23
|
+
* Used to return a placename [suggestion](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) for a partial string.
|
24
|
+
*
|
25
|
+
* @param requestOptions - Options for the request including authentication and other optional parameters.
|
26
|
+
* @returns A Promise that will resolve with the data from the response.
|
27
|
+
*/
|
28
|
+
export function suggest(
|
29
|
+
partialText: string,
|
30
|
+
requestOptions?: IEndpointOptions
|
31
|
+
): Promise<ISuggestResponse> {
|
32
|
+
const options: IEndpointOptions = {
|
33
|
+
endpoint: ARCGIS_ONLINE_GEOCODING_URL,
|
34
|
+
params: {},
|
35
|
+
...requestOptions
|
36
|
+
};
|
37
|
+
|
38
|
+
options.params.text = partialText;
|
39
|
+
|
40
|
+
return request(`${cleanUrl(options.endpoint)}/suggest`, options);
|
41
|
+
}
|
42
|
+
|
43
|
+
export default {
|
44
|
+
suggest
|
45
|
+
};
|
@@ -0,0 +1,194 @@
|
|
1
|
+
/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
|
2
|
+
* Apache-2.0 */
|
3
|
+
|
4
|
+
import { bulkGeocode } from "../src/bulk";
|
5
|
+
import { GeocodeAddresses } from "./mocks/responses";
|
6
|
+
|
7
|
+
import * as fetchMock from "fetch-mock";
|
8
|
+
|
9
|
+
const addresses = [
|
10
|
+
{
|
11
|
+
OBJECTID: 1,
|
12
|
+
SingleLine: "380 New York St. Redlands 92373"
|
13
|
+
},
|
14
|
+
{
|
15
|
+
OBJECTID: 2,
|
16
|
+
SingleLine: "1 World Way Los Angeles 90045"
|
17
|
+
},
|
18
|
+
{
|
19
|
+
OBJECTID: 3,
|
20
|
+
SingleLine: "foo bar baz"
|
21
|
+
}
|
22
|
+
];
|
23
|
+
|
24
|
+
describe("geocode", () => {
|
25
|
+
afterEach(fetchMock.restore);
|
26
|
+
|
27
|
+
it("should make a bulk geocoding request, even with an unmatchable record", done => {
|
28
|
+
fetchMock.once("*", GeocodeAddresses);
|
29
|
+
|
30
|
+
const MOCK_AUTH = {
|
31
|
+
getToken() {
|
32
|
+
return Promise.resolve("token");
|
33
|
+
},
|
34
|
+
portal: "https://mapsdev.arcgis.com"
|
35
|
+
};
|
36
|
+
|
37
|
+
bulkGeocode({ addresses, authentication: MOCK_AUTH })
|
38
|
+
.then(response => {
|
39
|
+
expect(fetchMock.called()).toEqual(true);
|
40
|
+
const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
|
41
|
+
expect(url).toEqual(
|
42
|
+
"https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/geocodeAddresses"
|
43
|
+
);
|
44
|
+
expect(options.method).toBe("POST");
|
45
|
+
expect(options.body).toContain("f=json");
|
46
|
+
expect(options.body).toContain(
|
47
|
+
`addresses=${encodeURIComponent(
|
48
|
+
'{"records":[{"attributes":{"OBJECTID":1,"SingleLine":"380 New York St. Redlands 92373"}},{"attributes":{"OBJECTID":2,"SingleLine":"1 World Way Los Angeles 90045"}},{"attributes":{"OBJECTID":3,"SingleLine":"foo bar baz"}}]}'
|
49
|
+
)}`
|
50
|
+
);
|
51
|
+
expect(options.body).toContain("token=token");
|
52
|
+
expect(response.spatialReference.latestWkid).toEqual(4326);
|
53
|
+
expect(response.locations[0].address).toEqual(
|
54
|
+
"380 New York St, Redlands, California, 92373"
|
55
|
+
);
|
56
|
+
expect(response.locations[0].location.x).toEqual(-117.19567031799994);
|
57
|
+
// the only property this lib tacks on
|
58
|
+
expect(response.locations[0].location.spatialReference.wkid).toEqual(
|
59
|
+
4326
|
60
|
+
);
|
61
|
+
expect(response.locations[2].score).toEqual(0);
|
62
|
+
done();
|
63
|
+
})
|
64
|
+
.catch(e => {
|
65
|
+
fail(e);
|
66
|
+
});
|
67
|
+
});
|
68
|
+
|
69
|
+
it("should throw an error when a bulk geocoding request is made without a token", done => {
|
70
|
+
fetchMock.once("*", GeocodeAddresses);
|
71
|
+
|
72
|
+
bulkGeocode({ addresses })
|
73
|
+
// tslint:disable-next-line
|
74
|
+
.catch(e => {
|
75
|
+
expect(e).toEqual(
|
76
|
+
"bulk geocoding using the ArcGIS service requires authentication"
|
77
|
+
);
|
78
|
+
done();
|
79
|
+
});
|
80
|
+
});
|
81
|
+
|
82
|
+
it("should send a bulk geocoding request to a custom url without a token", done => {
|
83
|
+
fetchMock.once("*", GeocodeAddresses);
|
84
|
+
|
85
|
+
bulkGeocode({
|
86
|
+
addresses,
|
87
|
+
endpoint:
|
88
|
+
"https://customer.gov/arcgis/rest/services/CompositeGeocoder/GeocodeServer/"
|
89
|
+
})
|
90
|
+
// tslint:disable-next-line
|
91
|
+
.then(response => {
|
92
|
+
expect(fetchMock.called()).toEqual(true);
|
93
|
+
const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
|
94
|
+
expect(url).toEqual(
|
95
|
+
"https://customer.gov/arcgis/rest/services/CompositeGeocoder/GeocodeServer/geocodeAddresses"
|
96
|
+
);
|
97
|
+
expect(options.method).toBe("POST");
|
98
|
+
expect(options.body).toContain("f=json");
|
99
|
+
expect(options.body).toContain(
|
100
|
+
`addresses=${encodeURIComponent(
|
101
|
+
'{"records":[{"attributes":{"OBJECTID":1,"SingleLine":"380 New York St. Redlands 92373"}},{"attributes":{"OBJECTID":2,"SingleLine":"1 World Way Los Angeles 90045"}},{"attributes":{"OBJECTID":3,"SingleLine":"foo bar baz"}}]}'
|
102
|
+
)}`
|
103
|
+
);
|
104
|
+
// expect(options.body).toContain("token=token");
|
105
|
+
expect(response.spatialReference.latestWkid).toEqual(4326);
|
106
|
+
expect(response.locations[0].address).toEqual(
|
107
|
+
"380 New York St, Redlands, California, 92373"
|
108
|
+
);
|
109
|
+
expect(response.locations[0].location.x).toEqual(-117.19567031799994);
|
110
|
+
// the only property this lib tacks on
|
111
|
+
expect(response.locations[0].location.spatialReference.wkid).toEqual(
|
112
|
+
4326
|
113
|
+
);
|
114
|
+
expect(response.locations[2].address).toEqual("foo bar baz");
|
115
|
+
done();
|
116
|
+
});
|
117
|
+
});
|
118
|
+
|
119
|
+
it("should send a bulk geocoding request with params correctly", done => {
|
120
|
+
fetchMock.once("*", GeocodeAddresses);
|
121
|
+
|
122
|
+
bulkGeocode({
|
123
|
+
addresses,
|
124
|
+
endpoint:
|
125
|
+
"https://customer.gov/arcgis/rest/services/CompositeGeocoder/GeocodeServer/",
|
126
|
+
params: {
|
127
|
+
outSR: 4326,
|
128
|
+
forStorage: true
|
129
|
+
}
|
130
|
+
})
|
131
|
+
// tslint:disable-next-line
|
132
|
+
.then(response => {
|
133
|
+
expect(fetchMock.called()).toEqual(true);
|
134
|
+
const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
|
135
|
+
expect(url).toEqual(
|
136
|
+
"https://customer.gov/arcgis/rest/services/CompositeGeocoder/GeocodeServer/geocodeAddresses"
|
137
|
+
);
|
138
|
+
expect(options.method).toBe("POST");
|
139
|
+
expect(options.body).toContain("f=json");
|
140
|
+
expect(options.body).toContain("outSR=4326");
|
141
|
+
expect(options.body).toContain("forStorage=true");
|
142
|
+
expect(options.body).toContain(
|
143
|
+
`addresses=${encodeURIComponent(
|
144
|
+
'{"records":[{"attributes":{"OBJECTID":1,"SingleLine":"380 New York St. Redlands 92373"}},{"attributes":{"OBJECTID":2,"SingleLine":"1 World Way Los Angeles 90045"}},{"attributes":{"OBJECTID":3,"SingleLine":"foo bar baz"}}]}'
|
145
|
+
)}`
|
146
|
+
);
|
147
|
+
// expect(options.body).toContain("token=token");
|
148
|
+
expect(response.spatialReference.latestWkid).toEqual(4326);
|
149
|
+
expect(response.locations[0].address).toEqual(
|
150
|
+
"380 New York St, Redlands, California, 92373"
|
151
|
+
);
|
152
|
+
expect(response.locations[0].location.x).toEqual(-117.19567031799994);
|
153
|
+
// the only property this lib tacks on
|
154
|
+
expect(response.locations[0].location.spatialReference.wkid).toEqual(
|
155
|
+
4326
|
156
|
+
);
|
157
|
+
expect(response.locations[2].address).toEqual("foo bar baz");
|
158
|
+
done();
|
159
|
+
});
|
160
|
+
});
|
161
|
+
|
162
|
+
it("should support rawResponse", done => {
|
163
|
+
fetchMock.once("*", GeocodeAddresses);
|
164
|
+
|
165
|
+
const MOCK_AUTH = {
|
166
|
+
getToken() {
|
167
|
+
return Promise.resolve("token");
|
168
|
+
},
|
169
|
+
portal: "https://mapsdev.arcgis.com"
|
170
|
+
};
|
171
|
+
|
172
|
+
bulkGeocode({ addresses, authentication: MOCK_AUTH, rawResponse: true })
|
173
|
+
.then((response: any) => {
|
174
|
+
expect(fetchMock.called()).toEqual(true);
|
175
|
+
const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
|
176
|
+
expect(url).toEqual(
|
177
|
+
"https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/geocodeAddresses"
|
178
|
+
);
|
179
|
+
expect(options.method).toBe("POST");
|
180
|
+
expect(response.status).toBe(200);
|
181
|
+
expect(response.ok).toBe(true);
|
182
|
+
expect(response.body.Readable).not.toBe(null);
|
183
|
+
response.json().then((raw: any) => {
|
184
|
+
expect(raw).toEqual(GeocodeAddresses);
|
185
|
+
done();
|
186
|
+
});
|
187
|
+
// this used to work with isomorphic-fetch
|
188
|
+
// expect(response instanceof Response).toBe(true);
|
189
|
+
})
|
190
|
+
.catch(e => {
|
191
|
+
fail(e);
|
192
|
+
});
|
193
|
+
});
|
194
|
+
});
|