sintfacilis 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (461) hide show
  1. package/.env.example +2 -0
  2. package/.eslintrc.js +20 -0
  3. package/.github/workflows/deploy-docs.yml +27 -0
  4. package/.github/workflows/pre-release-tests.yml +45 -0
  5. package/.github/workflows/pull-request-tests.yml +45 -0
  6. package/.prettierignore +2 -0
  7. package/.prettierrc +19 -0
  8. package/.vscode/launch.json +24 -0
  9. package/.vscode/settings.json +3 -0
  10. package/codecov.yml +7 -0
  11. package/demos/.eslintrc.js +13 -0
  12. package/demos/ago-node-cli/README.md +29 -0
  13. package/demos/ago-node-cli/ago.js +33 -0
  14. package/demos/ago-node-cli/index.js +11 -0
  15. package/demos/ago-node-cli/lib/item-export-command.js +48 -0
  16. package/demos/ago-node-cli/lib/item-search-command.js +35 -0
  17. package/demos/ago-node-cli/package-lock.json +430 -0
  18. package/demos/ago-node-cli/package.json +30 -0
  19. package/demos/attachments/README.md +5 -0
  20. package/demos/attachments/index.html +165 -0
  21. package/demos/attachments/package-lock.json +543 -0
  22. package/demos/attachments/package.json +18 -0
  23. package/demos/batch-geocoder-node/NYC_Restaurant_Inspection_Results.csv +100 -0
  24. package/demos/batch-geocoder-node/README.md +15 -0
  25. package/demos/batch-geocoder-node/batch-geocode.js +115 -0
  26. package/demos/batch-geocoder-node/config-template.js +18 -0
  27. package/demos/batch-geocoder-node/package-lock.json +336 -0
  28. package/demos/batch-geocoder-node/package.json +37 -0
  29. package/demos/express/README.md +15 -0
  30. package/demos/express/config.json.template +3 -0
  31. package/demos/express/package-lock.json +1008 -0
  32. package/demos/express/package.json +18 -0
  33. package/demos/express/server.js +33 -0
  34. package/demos/feature-service-browser/README.md +6 -0
  35. package/demos/feature-service-browser/index.html +122 -0
  36. package/demos/feature-service-browser/package-lock.json +543 -0
  37. package/demos/feature-service-browser/package.json +18 -0
  38. package/demos/geocoder-browser/README.md +10 -0
  39. package/demos/geocoder-browser/config.js.template +1 -0
  40. package/demos/geocoder-browser/index.html +131 -0
  41. package/demos/geocoder-browser/package-lock.json +610 -0
  42. package/demos/geocoder-browser/package.json +19 -0
  43. package/demos/geocoder-browser/post-sign-in.html +25 -0
  44. package/demos/jsapi-integration/README.md +25 -0
  45. package/demos/jsapi-integration/config.js +6 -0
  46. package/demos/jsapi-integration/index.html +93 -0
  47. package/demos/jsapi-integration/package-lock.json +247 -0
  48. package/demos/jsapi-integration/package.json +19 -0
  49. package/demos/node-cli-item-management/README.md +10 -0
  50. package/demos/node-cli-item-management/index.js +238 -0
  51. package/demos/node-cli-item-management/package-lock.json +432 -0
  52. package/demos/node-cli-item-management/package.json +27 -0
  53. package/demos/node-cli-item-management/screenshot.png +0 -0
  54. package/demos/oauth2-browser/README.md +14 -0
  55. package/demos/oauth2-browser/authenticate.html +30 -0
  56. package/demos/oauth2-browser/config.js.template +6 -0
  57. package/demos/oauth2-browser/index.html +211 -0
  58. package/demos/oauth2-browser/logo.svg +4 -0
  59. package/demos/oauth2-browser/package-lock.json +474 -0
  60. package/demos/oauth2-browser/package.json +18 -0
  61. package/demos/oauth2-browser/style.css +36 -0
  62. package/demos/oauth2-browser-retry/README.md +25 -0
  63. package/demos/oauth2-browser-retry/authenticate.html +22 -0
  64. package/demos/oauth2-browser-retry/index.html +116 -0
  65. package/demos/oauth2-browser-retry/logo.svg +4 -0
  66. package/demos/stream-response-to-file/README.md +7 -0
  67. package/demos/stream-response-to-file/index.js +36 -0
  68. package/demos/stream-response-to-file/output/.gitkeep +0 -0
  69. package/demos/stream-response-to-file/package-lock.json +227 -0
  70. package/demos/stream-response-to-file/package.json +33 -0
  71. package/demos/tree-shaking-rollup/.babelrc +3 -0
  72. package/demos/tree-shaking-rollup/README.md +9 -0
  73. package/demos/tree-shaking-rollup/index.html +11 -0
  74. package/demos/tree-shaking-rollup/package-lock.json +5646 -0
  75. package/demos/tree-shaking-rollup/package.json +25 -0
  76. package/demos/tree-shaking-rollup/rollup.config.js +17 -0
  77. package/demos/tree-shaking-rollup/src/index.js +8 -0
  78. package/demos/tree-shaking-webpack/README.md +8 -0
  79. package/demos/tree-shaking-webpack/index.html +11 -0
  80. package/demos/tree-shaking-webpack/package-lock.json +11455 -0
  81. package/demos/tree-shaking-webpack/package.json +24 -0
  82. package/demos/tree-shaking-webpack/src/index.js +10 -0
  83. package/demos/tree-shaking-webpack/webpack.config.js +27 -0
  84. package/demos/vue/.env.example +11 -0
  85. package/demos/vue/.eslintrc.js +17 -0
  86. package/demos/vue/.postcssrc.js +5 -0
  87. package/demos/vue/README.md +17 -0
  88. package/demos/vue/babel.config.js +3 -0
  89. package/demos/vue/package-lock.json +28044 -0
  90. package/demos/vue/package.json +33 -0
  91. package/demos/vue/public/favicon.ico +0 -0
  92. package/demos/vue/public/index.html +24 -0
  93. package/demos/vue/src/assets/logo.svg +29 -0
  94. package/demos/vue/src/components/App.vue +305 -0
  95. package/demos/vue/src/components/Authenticate.vue +65 -0
  96. package/demos/vue/src/components/Loader.vue +230 -0
  97. package/demos/vue/src/main.js +92 -0
  98. package/demos/webmap-checker-sapper/.env.example +5 -0
  99. package/demos/webmap-checker-sapper/README.md +123 -0
  100. package/demos/webmap-checker-sapper/appveyor.yml +18 -0
  101. package/demos/webmap-checker-sapper/cypress/fixtures/example.json +5 -0
  102. package/demos/webmap-checker-sapper/cypress/integration/spec.js +19 -0
  103. package/demos/webmap-checker-sapper/cypress/plugins/index.js +17 -0
  104. package/demos/webmap-checker-sapper/cypress/support/commands.js +25 -0
  105. package/demos/webmap-checker-sapper/cypress/support/index.js +20 -0
  106. package/demos/webmap-checker-sapper/cypress.json +4 -0
  107. package/demos/webmap-checker-sapper/package-lock.json +9622 -0
  108. package/demos/webmap-checker-sapper/package.json +50 -0
  109. package/demos/webmap-checker-sapper/rollup.config.js +87 -0
  110. package/demos/webmap-checker-sapper/src/client.js +20 -0
  111. package/demos/webmap-checker-sapper/src/components/LayerStatus.html +108 -0
  112. package/demos/webmap-checker-sapper/src/components/Nav.html +21 -0
  113. package/demos/webmap-checker-sapper/src/components/WebMap.html +62 -0
  114. package/demos/webmap-checker-sapper/src/routes/_error.html +41 -0
  115. package/demos/webmap-checker-sapper/src/routes/_layout.html +21 -0
  116. package/demos/webmap-checker-sapper/src/routes/auth/authorize.js +18 -0
  117. package/demos/webmap-checker-sapper/src/routes/auth/exchange-token.js +20 -0
  118. package/demos/webmap-checker-sapper/src/routes/auth/post-sign-in.js +24 -0
  119. package/demos/webmap-checker-sapper/src/routes/auth/sign-out.js +10 -0
  120. package/demos/webmap-checker-sapper/src/routes/index.html +20 -0
  121. package/demos/webmap-checker-sapper/src/routes/webmaps/[webmapId].html +83 -0
  122. package/demos/webmap-checker-sapper/src/routes/webmaps/index.html +59 -0
  123. package/demos/webmap-checker-sapper/src/server.js +101 -0
  124. package/demos/webmap-checker-sapper/src/service-worker.js +82 -0
  125. package/demos/webmap-checker-sapper/src/template.html +33 -0
  126. package/demos/webmap-checker-sapper/src/userInfoMiddleware.js +21 -0
  127. package/demos/webmap-checker-sapper/src/utils.js +33 -0
  128. package/demos/webmap-checker-sapper/static/favicon.png +0 -0
  129. package/demos/webmap-checker-sapper/static/global.css +36 -0
  130. package/demos/webmap-checker-sapper/static/manifest.json +20 -0
  131. package/demos/webmap-checker-sapper/static/svelte-logo-192.png +0 -0
  132. package/demos/webmap-checker-sapper/static/svelte-logo-512.png +0 -0
  133. package/docs/.eslintrc.js +12 -0
  134. package/docs/FAQ.md +48 -0
  135. package/docs/HISTORY.md +62 -0
  136. package/docs/acetate.config.js +262 -0
  137. package/docs/build-typedoc.js +434 -0
  138. package/docs/generate-srihashes.js +53 -0
  139. package/docs/src/_layout.html +86 -0
  140. package/docs/src/api/_declaration.html +600 -0
  141. package/docs/src/api/_layout.html +204 -0
  142. package/docs/src/api/_package.html +38 -0
  143. package/docs/src/api/index.html +16 -0
  144. package/docs/src/guides/_layout.html +24 -0
  145. package/docs/src/guides/amd-requirejs-dojo.md +40 -0
  146. package/docs/src/guides/browser-authentication.md +39 -0
  147. package/docs/src/guides/bundlers.md +52 -0
  148. package/docs/src/guides/cli-authentication.md +9 -0
  149. package/docs/src/guides/client-server-authentication.md +9 -0
  150. package/docs/src/guides/embedded-apps.md +106 -0
  151. package/docs/src/guides/from-a-cdn.md +38 -0
  152. package/docs/src/guides/index.md +59 -0
  153. package/docs/src/guides/node.md +104 -0
  154. package/docs/src/guides/package-overview.md +111 -0
  155. package/docs/src/guides/server-authentication.md +9 -0
  156. package/docs/src/guides/whats-new-v2-0.md +305 -0
  157. package/docs/src/img/icons.png +0 -0
  158. package/docs/src/img/icons@2x.png +0 -0
  159. package/docs/src/img/oauth-browser.png +0 -0
  160. package/docs/src/index.html +12 -0
  161. package/docs/src/js/api-search.js +112 -0
  162. package/docs/src/js/nav-toggle.js +41 -0
  163. package/docs/src/sass/_highlight.scss +96 -0
  164. package/docs/src/sass/_icons.scss +157 -0
  165. package/docs/src/sass/style.scss +242 -0
  166. package/docs/src/srihashes.json +12 -0
  167. package/jasmine.json +7 -0
  168. package/jasmine.live.json +7 -0
  169. package/karma.conf.js +107 -0
  170. package/lerna.json +8 -0
  171. package/notes/README.md +68 -0
  172. package/package.json +141 -0
  173. package/packages/arcgis-rest-auth/README.md +71 -0
  174. package/packages/arcgis-rest-auth/package.json +69 -0
  175. package/packages/arcgis-rest-auth/post-message-auth-spec.md +70 -0
  176. package/packages/arcgis-rest-auth/src/ApiKey.ts +41 -0
  177. package/packages/arcgis-rest-auth/src/ApplicationSession.ts +122 -0
  178. package/packages/arcgis-rest-auth/src/UserSession.ts +1355 -0
  179. package/packages/arcgis-rest-auth/src/app-tokens.ts +131 -0
  180. package/packages/arcgis-rest-auth/src/authenticated-request-options.ts +24 -0
  181. package/packages/arcgis-rest-auth/src/federation-utils.ts +85 -0
  182. package/packages/arcgis-rest-auth/src/fetch-token.ts +50 -0
  183. package/packages/arcgis-rest-auth/src/generate-token.ts +35 -0
  184. package/packages/arcgis-rest-auth/src/index.ts +13 -0
  185. package/packages/arcgis-rest-auth/src/validate-app-access.ts +68 -0
  186. package/packages/arcgis-rest-auth/test/ApiKey.test.ts +35 -0
  187. package/packages/arcgis-rest-auth/test/ApplicationSession.test.ts +124 -0
  188. package/packages/arcgis-rest-auth/test/UserSession.test.ts +2377 -0
  189. package/packages/arcgis-rest-auth/test/app-tokens.test.ts +95 -0
  190. package/packages/arcgis-rest-auth/test/federation-utils.test.ts +323 -0
  191. package/packages/arcgis-rest-auth/test/fetchToken.test.ts +112 -0
  192. package/packages/arcgis-rest-auth/test/generateToken.test.ts +102 -0
  193. package/packages/arcgis-rest-auth/test/utils.ts +14 -0
  194. package/packages/arcgis-rest-auth/test/validate-app-access.test.ts +46 -0
  195. package/packages/arcgis-rest-auth/tsconfig.json +6 -0
  196. package/packages/arcgis-rest-demographics/README.md +75 -0
  197. package/packages/arcgis-rest-demographics/package.json +69 -0
  198. package/packages/arcgis-rest-demographics/src/getAvailableCountries.ts +113 -0
  199. package/packages/arcgis-rest-demographics/src/getAvailableDataCollections.ts +166 -0
  200. package/packages/arcgis-rest-demographics/src/getAvailableGeographyLevels.ts +88 -0
  201. package/packages/arcgis-rest-demographics/src/getGeography.ts +152 -0
  202. package/packages/arcgis-rest-demographics/src/helpers.ts +28 -0
  203. package/packages/arcgis-rest-demographics/src/index.ts +8 -0
  204. package/packages/arcgis-rest-demographics/src/queryDemographicData.ts +106 -0
  205. package/packages/arcgis-rest-demographics/test/getAvailableCountries.test.ts +92 -0
  206. package/packages/arcgis-rest-demographics/test/getAvailableDataCollections.test.ts +115 -0
  207. package/packages/arcgis-rest-demographics/test/getAvailableGeographyLevels.test.ts +72 -0
  208. package/packages/arcgis-rest-demographics/test/getGeography.test.ts +141 -0
  209. package/packages/arcgis-rest-demographics/test/mocks/responses.ts +4 -0
  210. package/packages/arcgis-rest-demographics/test/queryDemographicData.test.live.ts +42 -0
  211. package/packages/arcgis-rest-demographics/test/queryDemographicData.test.ts +113 -0
  212. package/packages/arcgis-rest-demographics/tsconfig.json +6 -0
  213. package/packages/arcgis-rest-feature-layer/README.md +77 -0
  214. package/packages/arcgis-rest-feature-layer/package.json +64 -0
  215. package/packages/arcgis-rest-feature-layer/src/add.ts +56 -0
  216. package/packages/arcgis-rest-feature-layer/src/addAttachment.ts +53 -0
  217. package/packages/arcgis-rest-feature-layer/src/applyEdits.ts +95 -0
  218. package/packages/arcgis-rest-feature-layer/src/decodeValues.ts +122 -0
  219. package/packages/arcgis-rest-feature-layer/src/delete.ts +61 -0
  220. package/packages/arcgis-rest-feature-layer/src/deleteAttachments.ts +52 -0
  221. package/packages/arcgis-rest-feature-layer/src/getAllLayersAndTables.ts +30 -0
  222. package/packages/arcgis-rest-feature-layer/src/getAttachments.ts +55 -0
  223. package/packages/arcgis-rest-feature-layer/src/getLayer.ts +24 -0
  224. package/packages/arcgis-rest-feature-layer/src/getService.ts +26 -0
  225. package/packages/arcgis-rest-feature-layer/src/helpers.ts +97 -0
  226. package/packages/arcgis-rest-feature-layer/src/index.ts +32 -0
  227. package/packages/arcgis-rest-feature-layer/src/query.ts +204 -0
  228. package/packages/arcgis-rest-feature-layer/src/queryRelated.ts +89 -0
  229. package/packages/arcgis-rest-feature-layer/src/update.ts +60 -0
  230. package/packages/arcgis-rest-feature-layer/src/updateAttachment.ts +59 -0
  231. package/packages/arcgis-rest-feature-layer/test/attachments.test.ts +200 -0
  232. package/packages/arcgis-rest-feature-layer/test/crud.test.ts +197 -0
  233. package/packages/arcgis-rest-feature-layer/test/decodeValues.test.ts +67 -0
  234. package/packages/arcgis-rest-feature-layer/test/getAllLayersAndTables.test.ts +28 -0
  235. package/packages/arcgis-rest-feature-layer/test/getLayer.test.ts +31 -0
  236. package/packages/arcgis-rest-feature-layer/test/getService.test.ts +31 -0
  237. package/packages/arcgis-rest-feature-layer/test/helpers.test.ts +25 -0
  238. package/packages/arcgis-rest-feature-layer/test/mocks/allLayersAndTablesResponse.ts +906 -0
  239. package/packages/arcgis-rest-feature-layer/test/mocks/cvdQueryResponse.ts +225 -0
  240. package/packages/arcgis-rest-feature-layer/test/mocks/feature.ts +302 -0
  241. package/packages/arcgis-rest-feature-layer/test/mocks/fields.ts +779 -0
  242. package/packages/arcgis-rest-feature-layer/test/mocks/foo.txt +1 -0
  243. package/packages/arcgis-rest-feature-layer/test/mocks/service.ts +398 -0
  244. package/packages/arcgis-rest-feature-layer/test/query.test.ts +167 -0
  245. package/packages/arcgis-rest-feature-layer/tsconfig.json +6 -0
  246. package/packages/arcgis-rest-geocoding/README.md +86 -0
  247. package/packages/arcgis-rest-geocoding/package.json +66 -0
  248. package/packages/arcgis-rest-geocoding/src/bulk.ts +104 -0
  249. package/packages/arcgis-rest-geocoding/src/geocode.ts +166 -0
  250. package/packages/arcgis-rest-geocoding/src/helpers.ts +56 -0
  251. package/packages/arcgis-rest-geocoding/src/index.ts +15 -0
  252. package/packages/arcgis-rest-geocoding/src/reverse.ts +84 -0
  253. package/packages/arcgis-rest-geocoding/src/suggest.ts +45 -0
  254. package/packages/arcgis-rest-geocoding/test/bulk.test.ts +194 -0
  255. package/packages/arcgis-rest-geocoding/test/geocode.test.ts +253 -0
  256. package/packages/arcgis-rest-geocoding/test/helpers.test.ts +85 -0
  257. package/packages/arcgis-rest-geocoding/test/mocks/responses.ts +591 -0
  258. package/packages/arcgis-rest-geocoding/test/reverse.test.ts +126 -0
  259. package/packages/arcgis-rest-geocoding/test/suggest.test.ts +53 -0
  260. package/packages/arcgis-rest-geocoding/tsconfig.json +6 -0
  261. package/packages/arcgis-rest-portal/README.md +73 -0
  262. package/packages/arcgis-rest-portal/package.json +64 -0
  263. package/packages/arcgis-rest-portal/src/groups/add-users.ts +140 -0
  264. package/packages/arcgis-rest-portal/src/groups/create.ts +43 -0
  265. package/packages/arcgis-rest-portal/src/groups/get.ts +184 -0
  266. package/packages/arcgis-rest-portal/src/groups/helpers.ts +14 -0
  267. package/packages/arcgis-rest-portal/src/groups/invite-users.ts +127 -0
  268. package/packages/arcgis-rest-portal/src/groups/join.ts +57 -0
  269. package/packages/arcgis-rest-portal/src/groups/notification.ts +77 -0
  270. package/packages/arcgis-rest-portal/src/groups/protect.ts +56 -0
  271. package/packages/arcgis-rest-portal/src/groups/remove-users.ts +76 -0
  272. package/packages/arcgis-rest-portal/src/groups/remove.ts +32 -0
  273. package/packages/arcgis-rest-portal/src/groups/search.ts +47 -0
  274. package/packages/arcgis-rest-portal/src/groups/update-user-membership.ts +63 -0
  275. package/packages/arcgis-rest-portal/src/groups/update.ts +39 -0
  276. package/packages/arcgis-rest-portal/src/index.ts +69 -0
  277. package/packages/arcgis-rest-portal/src/items/add.ts +138 -0
  278. package/packages/arcgis-rest-portal/src/items/content.ts +67 -0
  279. package/packages/arcgis-rest-portal/src/items/create.ts +150 -0
  280. package/packages/arcgis-rest-portal/src/items/export.ts +80 -0
  281. package/packages/arcgis-rest-portal/src/items/get.ts +437 -0
  282. package/packages/arcgis-rest-portal/src/items/helpers.ts +292 -0
  283. package/packages/arcgis-rest-portal/src/items/protect.ts +41 -0
  284. package/packages/arcgis-rest-portal/src/items/reassign.ts +61 -0
  285. package/packages/arcgis-rest-portal/src/items/remove.ts +141 -0
  286. package/packages/arcgis-rest-portal/src/items/search.ts +25 -0
  287. package/packages/arcgis-rest-portal/src/items/update.ts +185 -0
  288. package/packages/arcgis-rest-portal/src/items/upload.ts +125 -0
  289. package/packages/arcgis-rest-portal/src/orgs/notification.ts +131 -0
  290. package/packages/arcgis-rest-portal/src/services/get-unique-service-name.ts +35 -0
  291. package/packages/arcgis-rest-portal/src/services/is-service-name-available.ts +30 -0
  292. package/packages/arcgis-rest-portal/src/sharing/access.ts +84 -0
  293. package/packages/arcgis-rest-portal/src/sharing/helpers.ts +81 -0
  294. package/packages/arcgis-rest-portal/src/sharing/is-item-shared-with-group.ts +42 -0
  295. package/packages/arcgis-rest-portal/src/sharing/share-item-with-group.ts +336 -0
  296. package/packages/arcgis-rest-portal/src/sharing/unshare-item-with-group.ts +105 -0
  297. package/packages/arcgis-rest-portal/src/users/get-user-tags.ts +52 -0
  298. package/packages/arcgis-rest-portal/src/users/get-user-url.ts +18 -0
  299. package/packages/arcgis-rest-portal/src/users/get-user.ts +58 -0
  300. package/packages/arcgis-rest-portal/src/users/invitation.ts +156 -0
  301. package/packages/arcgis-rest-portal/src/users/notification.ts +68 -0
  302. package/packages/arcgis-rest-portal/src/users/search-users.ts +37 -0
  303. package/packages/arcgis-rest-portal/src/users/update.ts +66 -0
  304. package/packages/arcgis-rest-portal/src/util/SearchQueryBuilder.ts +391 -0
  305. package/packages/arcgis-rest-portal/src/util/array.ts +16 -0
  306. package/packages/arcgis-rest-portal/src/util/generic-search.ts +99 -0
  307. package/packages/arcgis-rest-portal/src/util/get-portal-settings.ts +45 -0
  308. package/packages/arcgis-rest-portal/src/util/get-portal-url.ts +28 -0
  309. package/packages/arcgis-rest-portal/src/util/get-portal.ts +53 -0
  310. package/packages/arcgis-rest-portal/src/util/get-subscription-info.ts +43 -0
  311. package/packages/arcgis-rest-portal/src/util/scrub-control-chars.ts +13 -0
  312. package/packages/arcgis-rest-portal/src/util/search.ts +42 -0
  313. package/packages/arcgis-rest-portal/test/groups/add-users.test.ts +239 -0
  314. package/packages/arcgis-rest-portal/test/groups/crud.test.ts +180 -0
  315. package/packages/arcgis-rest-portal/test/groups/get.test.ts +176 -0
  316. package/packages/arcgis-rest-portal/test/groups/invite-users.test.ts +146 -0
  317. package/packages/arcgis-rest-portal/test/groups/join.test.ts +72 -0
  318. package/packages/arcgis-rest-portal/test/groups/notification.test.ts +112 -0
  319. package/packages/arcgis-rest-portal/test/groups/protect.test.ts +72 -0
  320. package/packages/arcgis-rest-portal/test/groups/remove-users.test.ts +140 -0
  321. package/packages/arcgis-rest-portal/test/groups/search.test.ts +151 -0
  322. package/packages/arcgis-rest-portal/test/groups/update-user-membership.test.ts +62 -0
  323. package/packages/arcgis-rest-portal/test/items/add.test.ts +323 -0
  324. package/packages/arcgis-rest-portal/test/items/content.test.ts +156 -0
  325. package/packages/arcgis-rest-portal/test/items/create.test.ts +400 -0
  326. package/packages/arcgis-rest-portal/test/items/export.test.ts +122 -0
  327. package/packages/arcgis-rest-portal/test/items/get.test.ts +583 -0
  328. package/packages/arcgis-rest-portal/test/items/helpers.test.ts +60 -0
  329. package/packages/arcgis-rest-portal/test/items/protect.test.ts +122 -0
  330. package/packages/arcgis-rest-portal/test/items/reassign.test.ts +131 -0
  331. package/packages/arcgis-rest-portal/test/items/remove.test.ts +261 -0
  332. package/packages/arcgis-rest-portal/test/items/search.test.ts +275 -0
  333. package/packages/arcgis-rest-portal/test/items/update.test.ts +556 -0
  334. package/packages/arcgis-rest-portal/test/items/upload.test.ts +282 -0
  335. package/packages/arcgis-rest-portal/test/mocks/groups/responses.ts +208 -0
  336. package/packages/arcgis-rest-portal/test/mocks/items/foo.zip +0 -0
  337. package/packages/arcgis-rest-portal/test/mocks/items/item.ts +526 -0
  338. package/packages/arcgis-rest-portal/test/mocks/items/resources.ts +38 -0
  339. package/packages/arcgis-rest-portal/test/mocks/items/search.ts +121 -0
  340. package/packages/arcgis-rest-portal/test/mocks/portal/response.ts +126 -0
  341. package/packages/arcgis-rest-portal/test/mocks/portal/settings-response.ts +56 -0
  342. package/packages/arcgis-rest-portal/test/mocks/sharing/sharing.ts +18 -0
  343. package/packages/arcgis-rest-portal/test/mocks/users/invitation.ts +70 -0
  344. package/packages/arcgis-rest-portal/test/mocks/users/notification.ts +34 -0
  345. package/packages/arcgis-rest-portal/test/mocks/users/user-search.ts +388 -0
  346. package/packages/arcgis-rest-portal/test/mocks/users/user-tags.ts +5 -0
  347. package/packages/arcgis-rest-portal/test/mocks/users/user.ts +174 -0
  348. package/packages/arcgis-rest-portal/test/orgs/notification.test.ts +144 -0
  349. package/packages/arcgis-rest-portal/test/services/get-unique-service-name.test.ts +59 -0
  350. package/packages/arcgis-rest-portal/test/services/is-service-name-available.test.ts +46 -0
  351. package/packages/arcgis-rest-portal/test/sharing/access.test.ts +162 -0
  352. package/packages/arcgis-rest-portal/test/sharing/helpers.test.ts +55 -0
  353. package/packages/arcgis-rest-portal/test/sharing/share-item-with-group.test.ts +1328 -0
  354. package/packages/arcgis-rest-portal/test/sharing/unshare-item-with-group.test.ts +288 -0
  355. package/packages/arcgis-rest-portal/test/users/get-user-tags.test.ts +71 -0
  356. package/packages/arcgis-rest-portal/test/users/get-user-url.test.ts +40 -0
  357. package/packages/arcgis-rest-portal/test/users/get-user.test.ts +90 -0
  358. package/packages/arcgis-rest-portal/test/users/invitation.test.ts +127 -0
  359. package/packages/arcgis-rest-portal/test/users/notification.test.ts +77 -0
  360. package/packages/arcgis-rest-portal/test/users/search.test.ts +42 -0
  361. package/packages/arcgis-rest-portal/test/users/update.test.ts +151 -0
  362. package/packages/arcgis-rest-portal/test/util/SearchQueryBuilder.test.ts +340 -0
  363. package/packages/arcgis-rest-portal/test/util/array.test.ts +30 -0
  364. package/packages/arcgis-rest-portal/test/util/get-portal-settings.test.ts +68 -0
  365. package/packages/arcgis-rest-portal/test/util/get-portal-url.test.ts +37 -0
  366. package/packages/arcgis-rest-portal/test/util/portal.test.ts +148 -0
  367. package/packages/arcgis-rest-portal/test/util/scrub-control-chars.test.ts +22 -0
  368. package/packages/arcgis-rest-portal/tsconfig.json +6 -0
  369. package/packages/arcgis-rest-request/README.md +72 -0
  370. package/packages/arcgis-rest-request/package.json +60 -0
  371. package/packages/arcgis-rest-request/src/index.ts +25 -0
  372. package/packages/arcgis-rest-request/src/request.ts +433 -0
  373. package/packages/arcgis-rest-request/src/utils/ArcGISRequestError.ts +76 -0
  374. package/packages/arcgis-rest-request/src/utils/ErrorTypes.ts +29 -0
  375. package/packages/arcgis-rest-request/src/utils/GrantTypes.ts +5 -0
  376. package/packages/arcgis-rest-request/src/utils/HTTPMethods.ts +6 -0
  377. package/packages/arcgis-rest-request/src/utils/IAuthenticationManager.ts +22 -0
  378. package/packages/arcgis-rest-request/src/utils/IFetchTokenParams.ts +11 -0
  379. package/packages/arcgis-rest-request/src/utils/IGenerateTokenParams.ts +9 -0
  380. package/packages/arcgis-rest-request/src/utils/IParamBuilder.ts +3 -0
  381. package/packages/arcgis-rest-request/src/utils/IParams.ts +6 -0
  382. package/packages/arcgis-rest-request/src/utils/IParamsBuilder.ts +5 -0
  383. package/packages/arcgis-rest-request/src/utils/IRequestOptions.ts +54 -0
  384. package/packages/arcgis-rest-request/src/utils/ITokenRequestOptions.ts +9 -0
  385. package/packages/arcgis-rest-request/src/utils/ResponseFormats.ts +10 -0
  386. package/packages/arcgis-rest-request/src/utils/append-custom-params.ts +49 -0
  387. package/packages/arcgis-rest-request/src/utils/clean-url.ts +20 -0
  388. package/packages/arcgis-rest-request/src/utils/decode-query-string.ts +27 -0
  389. package/packages/arcgis-rest-request/src/utils/encode-form-data.ts +38 -0
  390. package/packages/arcgis-rest-request/src/utils/encode-query-string.ts +35 -0
  391. package/packages/arcgis-rest-request/src/utils/process-params.ts +109 -0
  392. package/packages/arcgis-rest-request/src/utils/retryAuthError.ts +10 -0
  393. package/packages/arcgis-rest-request/src/utils/warn.ts +11 -0
  394. package/packages/arcgis-rest-request/src/utils/with-options.ts +48 -0
  395. package/packages/arcgis-rest-request/test/mocks/errors.ts +76 -0
  396. package/packages/arcgis-rest-request/test/mocks/geojson-feature-collection.ts +13 -0
  397. package/packages/arcgis-rest-request/test/mocks/param-builder.ts +7 -0
  398. package/packages/arcgis-rest-request/test/mocks/sharing-rest-info.ts +41 -0
  399. package/packages/arcgis-rest-request/test/mocks/webmap.ts +41 -0
  400. package/packages/arcgis-rest-request/test/request.test.ts +621 -0
  401. package/packages/arcgis-rest-request/test/utils/ArcGISAuthError.test.ts +191 -0
  402. package/packages/arcgis-rest-request/test/utils/ArcGISRequestError.test.ts +51 -0
  403. package/packages/arcgis-rest-request/test/utils/check-for-errors.test.ts +111 -0
  404. package/packages/arcgis-rest-request/test/utils/clean-url.test.ts +50 -0
  405. package/packages/arcgis-rest-request/test/utils/encode-form-data.test.ts +133 -0
  406. package/packages/arcgis-rest-request/test/utils/encode-query-string.test.ts +18 -0
  407. package/packages/arcgis-rest-request/test/utils/process-params.test.ts +205 -0
  408. package/packages/arcgis-rest-request/test/utils/with-options.test.ts +133 -0
  409. package/packages/arcgis-rest-request/tsconfig.json +4 -0
  410. package/packages/arcgis-rest-routing/README.md +75 -0
  411. package/packages/arcgis-rest-routing/package.json +65 -0
  412. package/packages/arcgis-rest-routing/src/closestFacility.ts +225 -0
  413. package/packages/arcgis-rest-routing/src/helpers.ts +104 -0
  414. package/packages/arcgis-rest-routing/src/index.ts +14 -0
  415. package/packages/arcgis-rest-routing/src/originDestinationMatrix.ts +223 -0
  416. package/packages/arcgis-rest-routing/src/serviceArea.ts +173 -0
  417. package/packages/arcgis-rest-routing/src/solveRoute.ts +180 -0
  418. package/packages/arcgis-rest-routing/test/closestFacility.test.ts +683 -0
  419. package/packages/arcgis-rest-routing/test/mocks/inputs.ts +132 -0
  420. package/packages/arcgis-rest-routing/test/mocks/responses.ts +13316 -0
  421. package/packages/arcgis-rest-routing/test/originDestinationMatrix.test.ts +795 -0
  422. package/packages/arcgis-rest-routing/test/serviceArea.test.ts +601 -0
  423. package/packages/arcgis-rest-routing/test/solveRoute.test.ts +677 -0
  424. package/packages/arcgis-rest-routing/tsconfig.json +6 -0
  425. package/packages/arcgis-rest-service-admin/README.md +73 -0
  426. package/packages/arcgis-rest-service-admin/package.json +65 -0
  427. package/packages/arcgis-rest-service-admin/src/addTo.ts +70 -0
  428. package/packages/arcgis-rest-service-admin/src/create.ts +189 -0
  429. package/packages/arcgis-rest-service-admin/src/get-service-admin-info.ts +34 -0
  430. package/packages/arcgis-rest-service-admin/src/get-view-sources.ts +20 -0
  431. package/packages/arcgis-rest-service-admin/src/index.ts +14 -0
  432. package/packages/arcgis-rest-service-admin/src/update.ts +50 -0
  433. package/packages/arcgis-rest-service-admin/test/addTo.test.ts +350 -0
  434. package/packages/arcgis-rest-service-admin/test/create.test.ts +294 -0
  435. package/packages/arcgis-rest-service-admin/test/get-service-admin-info.test.ts +37 -0
  436. package/packages/arcgis-rest-service-admin/test/get-view-sources.test.ts +40 -0
  437. package/packages/arcgis-rest-service-admin/test/mocks/layerDefinition.ts +79 -0
  438. package/packages/arcgis-rest-service-admin/test/mocks/service.ts +81 -0
  439. package/packages/arcgis-rest-service-admin/test/update.test.ts +115 -0
  440. package/packages/arcgis-rest-service-admin/tsconfig.json +5 -0
  441. package/packages/arcgis-rest-types/README.md +66 -0
  442. package/packages/arcgis-rest-types/package.json +54 -0
  443. package/packages/arcgis-rest-types/src/feature.ts +42 -0
  444. package/packages/arcgis-rest-types/src/geometry.ts +272 -0
  445. package/packages/arcgis-rest-types/src/group.ts +72 -0
  446. package/packages/arcgis-rest-types/src/index.ts +9 -0
  447. package/packages/arcgis-rest-types/src/item.ts +81 -0
  448. package/packages/arcgis-rest-types/src/service.ts +156 -0
  449. package/packages/arcgis-rest-types/src/statisticDefinition.ts +33 -0
  450. package/packages/arcgis-rest-types/src/symbol.ts +170 -0
  451. package/packages/arcgis-rest-types/src/user.ts +49 -0
  452. package/packages/arcgis-rest-types/src/webmap.ts +1405 -0
  453. package/packages/arcgis-rest-types/tsconfig.json +10 -0
  454. package/support/changelog.js +393 -0
  455. package/support/deploy-doc-site.js +16 -0
  456. package/support/dev.sh +6 -0
  457. package/support/publish.sh +47 -0
  458. package/support/test-helpers.js +9 -0
  459. package/tsconfig.json +63 -0
  460. package/umd-base-profile.js +81 -0
  461. package/umd-production-profile.js +13 -0
@@ -0,0 +1,6 @@
1
+ {
2
+ "extends": "../../tsconfig.json",
3
+ "include": [
4
+ "src/**/*.ts"
5
+ ]
6
+ }
@@ -0,0 +1,75 @@
1
+ [![npm version][npm-img]][npm-url]
2
+ [![build status][travis-img]][travis-url]
3
+ [![gzip bundle size][gzip-image]][npm-url]
4
+ [![Coverage Status][coverage-img]][coverage-url]
5
+ [![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/arcgis-rest-js/master/LICENSE)
6
+
7
+ [npm-img]: https://img.shields.io/npm/v/@esri/arcgis-rest-demographics.svg?style=flat-square
8
+ [npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-demographics
9
+ [travis-img]: https://img.shields.io/travis/Esri/arcgis-rest-js/master.svg?style=flat-square
10
+ [travis-url]: https://travis-ci.org/Esri/arcgis-rest-js
11
+ [gzip-image]: https://img.badgesize.io/https://unpkg.com/@esri/arcgis-rest-demographics/dist/umd/demographics.umd.min.js?compression=gzip
12
+ [coverage-img]: https://codecov.io/gh/Esri/arcgis-rest-js/branch/master/graph/badge.svg
13
+ [coverage-url]: https://codecov.io/gh/Esri/arcgis-rest-js
14
+
15
+ # @esri/arcgis-rest-demographics
16
+
17
+ > Demographics helpers for [`@esri/arcgis-rest-request`](https://github.com/Esri/arcgis-rest-js).
18
+
19
+ ### Example
20
+
21
+ ```bash
22
+ npm install @esri/arcgis-rest-request
23
+ npm install @esri/arcgis-rest-demographics
24
+ ```
25
+
26
+ ```js
27
+ import { getAvailableDataCollections } from '@esri/arcgis-rest-demographics';
28
+
29
+ getAvailableDataCollections()
30
+ .then((response) => {
31
+ response.DataCollections;
32
+ // => [{ dataCollectionId: "KeyGlobalFacts", metadata: { ... }, data: [ ... ] }, ... ]
33
+ });
34
+ ```
35
+
36
+ ### [API Reference](https://esri.github.io/arcgis-rest-js/api/demographics/)
37
+
38
+ * [`getAvailableDataCollections({countryCode: 'us'})`](https://esri.github.io/arcgis-rest-js/api/demographics/getAvailableDataCollections/)
39
+ * [`queryDemographicData({studyAreas: [{"geometry":{"x":-117.1956,"y":34.0572}}], authentication})`](https://esri.github.io/arcgis-rest-js/api/demographics/queryDemographicData/)
40
+
41
+ ### Issues
42
+
43
+ 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.
44
+
45
+ If you're looking for help you can also post issues on [GIS Stackexchange](http://gis.stackexchange.com/questions/ask?tags=esri-oss).
46
+
47
+ ### Versioning
48
+
49
+ 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.
50
+
51
+ For more information on SemVer, please visit <http://semver.org/>.
52
+
53
+ ### Contributing
54
+
55
+ Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](CONTRIBUTING.md).
56
+
57
+ ### [Changelog](https://github.com/Esri/arcgis-rest-js/blob/master/CHANGELOG.md)
58
+
59
+ ### License
60
+
61
+ Copyright &copy; 2017-2019 Esri
62
+
63
+ Licensed under the Apache License, Version 2.0 (the "License");
64
+ you may not use this file except in compliance with the License.
65
+ You may obtain a copy of the License at
66
+
67
+ > http://www.apache.org/licenses/LICENSE-2.0
68
+
69
+ Unless required by applicable law or agreed to in writing, software
70
+ distributed under the License is distributed on an "AS IS" BASIS,
71
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
72
+ See the License for the specific language governing permissions and
73
+ limitations under the License.
74
+
75
+ A copy of the license is available in the repository's [LICENSE](../../LICENSE) file.
@@ -0,0 +1,69 @@
1
+ {
2
+ "name": "@esri/arcgis-rest-demographics",
3
+ "version": "3.3.0",
4
+ "description": "Demographics data 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": "^3.3.0",
17
+ "tslib": "^1.13.0"
18
+ },
19
+ "devDependencies": {
20
+ "@esri/arcgis-rest-auth": "^3.3.0",
21
+ "@esri/arcgis-rest-request": "^3.3.0"
22
+ },
23
+ "peerDependencies": {
24
+ "@esri/arcgis-rest-auth": "^3.0.0",
25
+ "@esri/arcgis-rest-request": "^3.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-demographics"
44
+ },
45
+ "contributors": [
46
+ {
47
+ "name": "Patrick Arlt",
48
+ "email": "parlt@esri.com",
49
+ "url": "http://patrickarlt.com/"
50
+ },
51
+ {
52
+ "name": "Gavin Rehkemper",
53
+ "email": "grehkemper@esri.com",
54
+ "url": "http://gavinr.com/"
55
+ }
56
+ ],
57
+ "bugs": {
58
+ "url": "https://github.com/Esri/arcgis-rest-js/issues"
59
+ },
60
+ "homepage": "https://github.com/Esri/arcgis-rest-js#readme",
61
+ "keywords": [
62
+ "typescript",
63
+ "promise",
64
+ "fetch",
65
+ "arcgis",
66
+ "esri",
67
+ "ES6"
68
+ ]
69
+ }
@@ -0,0 +1,113 @@
1
+ /* Copyright (c) 2020 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
+ import { IEnvelope } from "@esri/arcgis-rest-types";
10
+
11
+ import { ARCGIS_ONLINE_GEOENRICHMENT_URL, IEndpointOptions } from "./helpers";
12
+
13
+ export interface IGetAvailableCountriesOptions extends IEndpointOptions {
14
+ /**
15
+ * View a description for a given country. If not specified, will return a list of all countries.
16
+ */
17
+ countryCode?: string;
18
+ }
19
+
20
+ export interface IGetAvailableCountriesResponse {
21
+ messages?: string[];
22
+ countries?: ICountry[];
23
+ childResources?: any[];
24
+ }
25
+ export interface ICountry {
26
+ id: string;
27
+ name: string;
28
+ abbr3: string;
29
+ altName: string;
30
+ continent: string;
31
+ distanceUnits: string;
32
+ esriUnits: string;
33
+ defaultExtent: IEnvelope;
34
+ defaultDatasetID: string;
35
+ datasets?: string[];
36
+ hierarchies?: IHierarchy[];
37
+ defaultDataCollection: string;
38
+ dataCollections: string;
39
+ defaultReportTemplate: string;
40
+ currencySymbol: string;
41
+ currencyFormat: string;
42
+ }
43
+ export interface IHierarchy {
44
+ ID: string;
45
+ alias: string;
46
+ shortDescription: string;
47
+ default: boolean;
48
+ longDescription: string;
49
+ locales?: string[];
50
+ datasets?: string[];
51
+ levelsInfo: ILevelsInfo;
52
+ variablesInfo: IVariablesInfo;
53
+ populationToPolygonSizeRating: number;
54
+ apportionmentConfidence: number;
55
+ apportionmentThresholds?: IApportionmentThreshold[];
56
+ hasMarginOfErrorData?: boolean;
57
+ }
58
+ export interface ILevelsInfo {
59
+ geographyLevels?: string[];
60
+ }
61
+ export interface IVariablesInfo {
62
+ categories?: string[];
63
+ }
64
+ export interface IApportionmentThreshold {
65
+ method: string;
66
+ dataLayer: string;
67
+ pointsLayer?: string;
68
+ maximumSize?: number;
69
+ }
70
+
71
+
72
+ /**
73
+ * ```js
74
+ * import { getAvailableCountries } from '@esri/arcgis-rest-demographics';
75
+ * //
76
+ * getAvailableCountries()
77
+ * .then((response) => {
78
+ * response; // => { countries: [ ... ] }
79
+ * });
80
+ * ```
81
+ * Return a list of information for all countries. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/countries.htm) for more information.
82
+ * @param requestOptions Options to pass through to the geoenrichment service.
83
+ * @returns A Promise that will resolve with available geography levels for the request.
84
+ */
85
+ export function getAvailableCountries(
86
+ requestOptions?: IGetAvailableCountriesOptions
87
+ ): Promise<IGetAvailableCountriesResponse> {
88
+ let options: IEndpointOptions = {};
89
+ let endpoint = `${ARCGIS_ONLINE_GEOENRICHMENT_URL}/countries`;
90
+ if (!requestOptions) {
91
+ options.params = {};
92
+ } else {
93
+ if (requestOptions.endpoint) {
94
+ endpoint = `${requestOptions.endpoint}/countries`;
95
+ }
96
+
97
+ options = appendCustomParams<IGetAvailableCountriesOptions>(
98
+ requestOptions,
99
+ [],
100
+ { params: { ...requestOptions.params } }
101
+ );
102
+ if (requestOptions.countryCode) {
103
+ endpoint = `${endpoint}/${requestOptions.countryCode}`;
104
+ }
105
+ }
106
+
107
+
108
+ return request(cleanUrl(endpoint), options).then(
109
+ (response: any) => {
110
+ return response;
111
+ }
112
+ );
113
+ }
@@ -0,0 +1,166 @@
1
+ /* Copyright (c) 2020 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 { ARCGIS_ONLINE_GEOENRICHMENT_URL, IEndpointOptions } from "./helpers";
11
+
12
+ export interface IGetAvailableDataCollectionsOptions extends IEndpointOptions {
13
+ /**
14
+ * Optional parameter to specify an array of string values that describe what derivative variables to include in the output.
15
+ */
16
+ addDerivativeVariables?: string[];
17
+ /**
18
+ * Optional parameter to return only values that are not NULL in the output response.
19
+ */
20
+ suppressNullValues?: boolean;
21
+ /**
22
+ * View a description for a single data collection within a given country. If not specified, will return a list of data collections that can be run in any country.
23
+ */
24
+ countryCode?: string;
25
+ dataCollection?: string;
26
+ }
27
+
28
+
29
+ export interface IGetAvailableDataCollectionsResponse {
30
+ DataCollections?: (IDataCollection)[] | null;
31
+ }
32
+ export interface IDataCollection {
33
+ dataCollectionID: string;
34
+ metadata: IMetadata;
35
+ data?: (IDataInfo)[] | null;
36
+ }
37
+ export interface IMetadata {
38
+ title: string;
39
+ name: string;
40
+ shortDescription: string;
41
+ longDescription: string;
42
+ url: string;
43
+ keywords: string;
44
+ creationDate: number;
45
+ lastRevisionDate: number;
46
+ webmap: string;
47
+ author: string;
48
+ countries?: string | null;
49
+ IsRoyalties: boolean;
50
+ categories?: ICategory[] | null;
51
+ filters?: (IFilter)[] | null;
52
+ datasets?: string | null;
53
+ hierarchies: string;
54
+ coverage?: string | null;
55
+ mobileinfographics?: string | null;
56
+ icon?: string | null;
57
+ }
58
+ export interface ICategory {
59
+ id: string;
60
+ name: string;
61
+ alias: string;
62
+ description: string;
63
+ displayOrder: string;
64
+ }
65
+ export interface IFilter {
66
+ id: string;
67
+ name: string;
68
+ aliasname: string;
69
+ type: string;
70
+ rangeMax?: string | null;
71
+ rangeMin?: string | null;
72
+ enumValues?: string | null;
73
+ }
74
+ export interface IDataInfo {
75
+ id: string;
76
+ alias: string;
77
+ type: string;
78
+ precision: number;
79
+ length?: null;
80
+ averageBase?: null;
81
+ averageBaseAlias?: null;
82
+ description: string;
83
+ fieldCategory: string;
84
+ indexBase?: number | null;
85
+ percentBase?: string | null;
86
+ percentBaseAlias?: string | null;
87
+ popularity?: number | null;
88
+ units: string;
89
+ vintage?: string | null;
90
+ hideInDataBrowser: boolean;
91
+ filteringTags?: IFilteringTag[] | null;
92
+ derivative: boolean;
93
+ provider: string;
94
+ indexType?: string | null;
95
+ }
96
+ export interface IFilteringTag {
97
+ id: string;
98
+ name: string;
99
+ value: string;
100
+ }
101
+
102
+
103
+ /**
104
+ * ```js
105
+ * import { getAvailableDataCollections } from '@esri/arcgis-rest-demographics';
106
+ * //
107
+ * getAvailableDataCollections()
108
+ * .then((response) => {
109
+ * response; // => { DataCollections: [ ... ] }
110
+ * });
111
+ * //
112
+ * getAvailableDataCollections({
113
+ * countryCode: "se",
114
+ * dataCollection: "EducationalAttainment"
115
+ * })
116
+ * .then((response) => {
117
+ * response.; // => { DataCollections: [ ... ] }
118
+ * });
119
+ * ```
120
+ * Used to determine the data collections available for usage with the Geoenrichment service. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/data-collections.htm) for more information.
121
+ * @param requestOptions Options to pass through to the geoenrichment service.
122
+ * @returns A Promise that will resolve with data collections for the request.
123
+ */
124
+ export function getAvailableDataCollections(
125
+ requestOptions?: IGetAvailableDataCollectionsOptions
126
+ ): Promise<IGetAvailableDataCollectionsResponse> {
127
+ let options: IGetAvailableDataCollectionsOptions = {};
128
+ let endpoint = `${ARCGIS_ONLINE_GEOENRICHMENT_URL}/dataCollections`;
129
+
130
+
131
+ if (!requestOptions) {
132
+ options.params = {};
133
+ } else {
134
+ if (requestOptions.endpoint) {
135
+ endpoint = `${requestOptions.endpoint}/dataCollections`;
136
+ }
137
+ options = appendCustomParams<IGetAvailableDataCollectionsOptions>(
138
+ requestOptions,
139
+ [
140
+ "addDerivativeVariables",
141
+ "suppressNullValues",
142
+ ],
143
+ { params: { ...requestOptions.params } }
144
+ );
145
+
146
+ if (options.params.addDerivativeVariables) {
147
+ options.params.addDerivativeVariables = JSON.stringify(options.params.addDerivativeVariables);
148
+ }
149
+
150
+ if(requestOptions.countryCode) {
151
+ endpoint = `${endpoint}/${requestOptions.countryCode}`;
152
+ if(requestOptions.dataCollection) {
153
+ endpoint = `${endpoint}/${requestOptions.dataCollection}`;
154
+ }
155
+ }
156
+ }
157
+
158
+
159
+
160
+ // add spatialReference property to individual matches
161
+ return request(`${cleanUrl(endpoint)}`, options).then(
162
+ (response: any) => {
163
+ return response;
164
+ }
165
+ );
166
+ }
@@ -0,0 +1,88 @@
1
+ /* Copyright (c) 2020 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 { ARCGIS_ONLINE_GEOENRICHMENT_URL, IEndpointOptions } from "./helpers";
11
+
12
+ export interface IGetAvailableGeographyLevelsResponse {
13
+ messages?: string[] | null;
14
+ childResources?: any[] | null;
15
+ childDatasets?: any[] | null;
16
+ childHierarchies?: any[] | null;
17
+ geographyLevels?: IGeographyLevel[] | null;
18
+ }
19
+ export interface IGeographyLevel {
20
+ countryID: string;
21
+ countryName: string;
22
+ datasets?: IDataset[] | null;
23
+ hierarchies?: IGeographyLevelHierarchy[] | null;
24
+ }
25
+ export interface IDataset {
26
+ datasetID: string;
27
+ branches?: IBranch[] | null;
28
+ levels?: ILevel[] | null;
29
+ }
30
+ export interface IBranch {
31
+ id: string;
32
+ name: string;
33
+ levels?: string[] | null;
34
+ }
35
+ export interface ILevel {
36
+ id: string;
37
+ name: string;
38
+ isWholeCountry: boolean;
39
+ adminLevel: string;
40
+ singularName: string;
41
+ pluralName: string;
42
+ description?: string | null;
43
+ }
44
+ export interface IGeographyLevelHierarchy {
45
+ ID: string;
46
+ branches?: IBranch[] | null;
47
+ levels?: ILevel[] | null;
48
+ }
49
+
50
+
51
+ /**
52
+ * ```js
53
+ * import { getAvailableGeographyLevels } from '@esri/arcgis-rest-demographics';
54
+ * //
55
+ * getAvailableGeographyLevels()
56
+ * .then((response) => {
57
+ * response; // => { geographyLevels: [ ... ] }
58
+ * });
59
+ * ```
60
+ * Returns a list of available geography data layers, which can then be used in [getGeography()](). See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-levels.htm) for more information.
61
+ * @param requestOptions Options to pass through to the geoenrichment service.
62
+ * @returns A Promise that will resolve with available geography levels for the request.
63
+ */
64
+ export function getAvailableGeographyLevels(
65
+ requestOptions?: IEndpointOptions
66
+ ): Promise<IGetAvailableGeographyLevelsResponse> {
67
+ let options: IEndpointOptions = {};
68
+ let endpoint = `${ARCGIS_ONLINE_GEOENRICHMENT_URL}/StandardGeographyLevels`;
69
+
70
+ if (!requestOptions) {
71
+ options.params = {};
72
+ } else {
73
+ if (requestOptions.endpoint) {
74
+ endpoint = `${requestOptions.endpoint}/StandardGeographyLevels`;
75
+ }
76
+ options = appendCustomParams<IEndpointOptions>(
77
+ requestOptions,
78
+ [],
79
+ { params: { ...requestOptions.params } }
80
+ );
81
+ }
82
+
83
+ return request(`${cleanUrl(endpoint)}`, options).then(
84
+ (response: any) => {
85
+ return response;
86
+ }
87
+ );
88
+ }
@@ -0,0 +1,152 @@
1
+ /* Copyright (c) 2020 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 { ARCGIS_ONLINE_STANDARD_GEOGRAPHY_QUERY_URL, IGeoenrichmentResult, IEndpointOptions } from "./helpers";
11
+
12
+ export interface IGetGeographyOptions extends IEndpointOptions {
13
+ /**
14
+ * Specify the source country for the search.
15
+ */
16
+ sourceCountry?: string;
17
+ /**
18
+ * Specify a specific dataset within a defined country.
19
+ */
20
+ optionalCountryDataset?: string;
21
+ /**
22
+ * Specify which standard geography layers are being queried or searched.
23
+ */
24
+ geographyLayers?: string[] | string;
25
+ /**
26
+ * Specify which IDs for the standard geography layers are being queried or searched.
27
+ */
28
+ geographyIDs?: string[];
29
+ /**
30
+ * Specify the text to query and search the standard geography layers specified.
31
+ */
32
+ geographyQuery?: string;
33
+ /**
34
+ * Return all the subgeographic areas that are within a parent geography.
35
+ */
36
+ returnSubGeographyLayer?: boolean;
37
+ /**
38
+ * Return all the subgeographic areas that are within a parent geography.
39
+ */
40
+ subGeographyLayer?: string;
41
+ /**
42
+ * Filter the results of the subgeography features that are returned by a search term.
43
+ */
44
+ subGeographyQuery?: string;
45
+ /**
46
+ * Request the output geometries in a specified spatial reference system.
47
+ */
48
+ outSR?: number;
49
+ /**
50
+ * Request the output geometries in the response.
51
+ */
52
+ returnGeometry?: boolean;
53
+ /**
54
+ * Request the output geometry to return the center point for each feature.
55
+ */
56
+ returnCentroids?: boolean;
57
+ /**
58
+ * Integer that specifies the level of generalization or detail in the area representations of the administrative boundary or standard geographic data layers.
59
+ */
60
+ generalizationLevel?: number;
61
+ /**
62
+ * Define if text provided in the geographyQuery parameter should utilize fuzzy search logic.
63
+ */
64
+ useFuzzySearch?: boolean;
65
+ /**
66
+ * Limits the number of features that are returned from the geographyQuery parameter.
67
+ */
68
+ featureLimit?: number;
69
+ /**
70
+ * Starts the results on the number of the records specified.
71
+ */
72
+ featureOffset?: number;
73
+ /**
74
+ * Specifies the language you wish to receive your GeoEnrichment results.
75
+ */
76
+ langCode?: string;
77
+ }
78
+
79
+
80
+ export interface IGetGeographyResponse {
81
+ results: IGeoenrichmentResult[] | null;
82
+ messages: string[] | null;
83
+ }
84
+
85
+ /**
86
+ * ```js
87
+ * import { getGeography } from '@esri/arcgis-rest-demographics';
88
+ * //
89
+ * getGeography({
90
+ * sourceCountry: "CA",
91
+ * geographyIDs: ["35"]
92
+ * })
93
+ * .then((response) => {
94
+ * response.; // => { results: [ ... ] }
95
+ * });
96
+ * ```
97
+ * Used to get standard geography IDs and features for the supported geographic levels. See the [REST Documentation](https://developers.arcgis.com/rest/geoenrichment/api-reference/standard-geography-query.htm) and the [best practices post](https://www.esri.com/arcgis-blog/products/arcgis-online/uncategorized/best-practices-how-to-query-standard-geographies-branches) for more information.
98
+ * @param requestOptions Options to pass through to the service. All properties are optional, but either `geographyIds` or `geographyQuery` must be sent at a minimum.
99
+ * @returns A Promise that will resolve with return data defined and optionally geometry for the feature.
100
+ */
101
+ export function getGeography(
102
+ requestOptions?: IGetGeographyOptions
103
+ ): Promise<IGetGeographyResponse> {
104
+ const endpoint = `${requestOptions.endpoint || ARCGIS_ONLINE_STANDARD_GEOGRAPHY_QUERY_URL}/execute`;
105
+
106
+ const options = appendCustomParams<IGetGeographyOptions>(
107
+ requestOptions,
108
+ [
109
+ "sourceCountry",
110
+ "optionalCountryDataset",
111
+ "geographyLayers",
112
+ "geographyIDs",
113
+ "geographyQuery",
114
+ "returnSubGeographyLayer",
115
+ "subGeographyLayer",
116
+ "subGeographyQuery",
117
+ "outSR",
118
+ "returnGeometry",
119
+ "returnCentroids",
120
+ "generalizationLevel",
121
+ "useFuzzySearch",
122
+ "featureLimit",
123
+ "featureOffset",
124
+ "langCode",
125
+ ],
126
+ { params: { ...requestOptions.params } }
127
+ );
128
+
129
+ // the SAAS service does not support anonymous requests
130
+ if (
131
+ !requestOptions.authentication
132
+ ) {
133
+ return Promise.reject(
134
+ "Geoenrichment using the ArcGIS service requires authentication"
135
+ );
136
+ }
137
+
138
+ // These parameters are passed as JSON-style strings:
139
+ ["geographyLayers", "geographyIDs"].forEach((parameter) => {
140
+ if (options.params[parameter]) {
141
+ options.params[parameter] = JSON.stringify(options.params[parameter]);
142
+ }
143
+ });
144
+
145
+
146
+ // add spatialReference property to individual matches
147
+ return request(`${cleanUrl(endpoint)}`, options).then(
148
+ (response: any) => {
149
+ return response;
150
+ }
151
+ );
152
+ }
@@ -0,0 +1,28 @@
1
+ /* Copyright (c) 2020 Environmental Systems Research Institute, Inc.
2
+ * Apache-2.0 */
3
+
4
+ import {
5
+ IRequestOptions
6
+ } from "@esri/arcgis-rest-request";
7
+
8
+ import { IFeatureSet } from "@esri/arcgis-rest-types";
9
+
10
+ const ARCGIS_ONLINE_GEOENRICHMENTSERVER_URL = "https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver"
11
+ export const ARCGIS_ONLINE_GEOENRICHMENT_URL = `${ARCGIS_ONLINE_GEOENRICHMENTSERVER_URL}/Geoenrichment`;
12
+ export const ARCGIS_ONLINE_STANDARD_GEOGRAPHY_QUERY_URL = `${ARCGIS_ONLINE_GEOENRICHMENTSERVER_URL}/StandardGeographyQuery`;
13
+
14
+ export interface IEndpointOptions extends IRequestOptions {
15
+ /**
16
+ * Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )
17
+ */
18
+ endpoint?: string;
19
+ }
20
+
21
+ export interface IGeoenrichmentResult {
22
+ paramName: string;
23
+ dataType: string;
24
+ value: {
25
+ version: string;
26
+ FeatureSet: IFeatureSet[];
27
+ };
28
+ }