impeditmaiores 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (421) hide show
  1. package/.prettierignore +2 -0
  2. package/.travis.yml +35 -0
  3. package/.vscode/launch.json +24 -0
  4. package/.vscode/settings.json +3 -0
  5. package/codecov.yml +7 -0
  6. package/demos/ago-node-cli/README.md +29 -0
  7. package/demos/ago-node-cli/ago.js +33 -0
  8. package/demos/ago-node-cli/index.js +11 -0
  9. package/demos/ago-node-cli/lib/item-export-command.js +48 -0
  10. package/demos/ago-node-cli/lib/item-search-command.js +35 -0
  11. package/demos/ago-node-cli/package-lock.json +152 -0
  12. package/demos/ago-node-cli/package.json +30 -0
  13. package/demos/attachments/README.md +5 -0
  14. package/demos/attachments/index.html +165 -0
  15. package/demos/attachments/package-lock.json +182 -0
  16. package/demos/attachments/package.json +18 -0
  17. package/demos/batch-geocoder-node/NYC_Restaurant_Inspection_Results.csv +100 -0
  18. package/demos/batch-geocoder-node/README.md +15 -0
  19. package/demos/batch-geocoder-node/batch-geocode.js +115 -0
  20. package/demos/batch-geocoder-node/config-template.js +18 -0
  21. package/demos/batch-geocoder-node/package-lock.json +81 -0
  22. package/demos/batch-geocoder-node/package.json +37 -0
  23. package/demos/express/README.md +15 -0
  24. package/demos/express/config.json.template +3 -0
  25. package/demos/express/package-lock.json +413 -0
  26. package/demos/express/package.json +18 -0
  27. package/demos/express/server.js +33 -0
  28. package/demos/feature-service-browser/README.md +6 -0
  29. package/demos/feature-service-browser/index.html +122 -0
  30. package/demos/feature-service-browser/package-lock.json +182 -0
  31. package/demos/feature-service-browser/package.json +18 -0
  32. package/demos/geocoder-browser/README.md +10 -0
  33. package/demos/geocoder-browser/config.js.template +1 -0
  34. package/demos/geocoder-browser/index.html +131 -0
  35. package/demos/geocoder-browser/package-lock.json +182 -0
  36. package/demos/geocoder-browser/package.json +19 -0
  37. package/demos/geocoder-browser/post-sign-in.html +25 -0
  38. package/demos/jsapi-integration/README.md +25 -0
  39. package/demos/jsapi-integration/config.js +6 -0
  40. package/demos/jsapi-integration/index.html +89 -0
  41. package/demos/jsapi-integration/package-lock.json +184 -0
  42. package/demos/jsapi-integration/package.json +19 -0
  43. package/demos/node-cli-item-management/README.md +10 -0
  44. package/demos/node-cli-item-management/index.js +238 -0
  45. package/demos/node-cli-item-management/package-lock.json +152 -0
  46. package/demos/node-cli-item-management/package.json +27 -0
  47. package/demos/node-cli-item-management/screenshot.png +0 -0
  48. package/demos/oauth2-browser/README.md +14 -0
  49. package/demos/oauth2-browser/authenticate.html +30 -0
  50. package/demos/oauth2-browser/config.js.template +6 -0
  51. package/demos/oauth2-browser/index.html +211 -0
  52. package/demos/oauth2-browser/logo.svg +4 -0
  53. package/demos/oauth2-browser/package-lock.json +224 -0
  54. package/demos/oauth2-browser/package.json +18 -0
  55. package/demos/oauth2-browser/style.css +36 -0
  56. package/demos/oauth2-browser-retry/README.md +25 -0
  57. package/demos/oauth2-browser-retry/authenticate.html +22 -0
  58. package/demos/oauth2-browser-retry/index.html +116 -0
  59. package/demos/oauth2-browser-retry/logo.svg +4 -0
  60. package/demos/stream-response-to-file/README.md +7 -0
  61. package/demos/stream-response-to-file/index.js +36 -0
  62. package/demos/stream-response-to-file/output/.gitkeep +0 -0
  63. package/demos/stream-response-to-file/package-lock.json +60 -0
  64. package/demos/stream-response-to-file/package.json +33 -0
  65. package/demos/tree-shaking-rollup/.babelrc +3 -0
  66. package/demos/tree-shaking-rollup/README.md +9 -0
  67. package/demos/tree-shaking-rollup/index.html +11 -0
  68. package/demos/tree-shaking-rollup/package-lock.json +2225 -0
  69. package/demos/tree-shaking-rollup/package.json +25 -0
  70. package/demos/tree-shaking-rollup/rollup.config.js +17 -0
  71. package/demos/tree-shaking-rollup/src/index.js +8 -0
  72. package/demos/tree-shaking-webpack/README.md +8 -0
  73. package/demos/tree-shaking-webpack/index.html +11 -0
  74. package/demos/tree-shaking-webpack/package-lock.json +4614 -0
  75. package/demos/tree-shaking-webpack/package.json +24 -0
  76. package/demos/tree-shaking-webpack/src/index.js +10 -0
  77. package/demos/tree-shaking-webpack/webpack.config.js +27 -0
  78. package/demos/vue/.env.example +11 -0
  79. package/demos/vue/.eslintrc.js +17 -0
  80. package/demos/vue/.postcssrc.js +5 -0
  81. package/demos/vue/README.md +17 -0
  82. package/demos/vue/babel.config.js +3 -0
  83. package/demos/vue/package-lock.json +11342 -0
  84. package/demos/vue/package.json +33 -0
  85. package/demos/vue/public/favicon.ico +0 -0
  86. package/demos/vue/public/index.html +24 -0
  87. package/demos/vue/src/assets/logo.svg +29 -0
  88. package/demos/vue/src/components/App.vue +305 -0
  89. package/demos/vue/src/components/Authenticate.vue +65 -0
  90. package/demos/vue/src/components/Loader.vue +230 -0
  91. package/demos/vue/src/main.js +92 -0
  92. package/demos/webmap-checker-sapper/.env.example +5 -0
  93. package/demos/webmap-checker-sapper/README.md +123 -0
  94. package/demos/webmap-checker-sapper/appveyor.yml +18 -0
  95. package/demos/webmap-checker-sapper/cypress/fixtures/example.json +5 -0
  96. package/demos/webmap-checker-sapper/cypress/integration/spec.js +19 -0
  97. package/demos/webmap-checker-sapper/cypress/plugins/index.js +17 -0
  98. package/demos/webmap-checker-sapper/cypress/support/commands.js +25 -0
  99. package/demos/webmap-checker-sapper/cypress/support/index.js +20 -0
  100. package/demos/webmap-checker-sapper/cypress.json +4 -0
  101. package/demos/webmap-checker-sapper/package-lock.json +3870 -0
  102. package/demos/webmap-checker-sapper/package.json +50 -0
  103. package/demos/webmap-checker-sapper/rollup.config.js +87 -0
  104. package/demos/webmap-checker-sapper/src/client.js +20 -0
  105. package/demos/webmap-checker-sapper/src/components/LayerStatus.html +108 -0
  106. package/demos/webmap-checker-sapper/src/components/Nav.html +21 -0
  107. package/demos/webmap-checker-sapper/src/components/WebMap.html +62 -0
  108. package/demos/webmap-checker-sapper/src/routes/_error.html +41 -0
  109. package/demos/webmap-checker-sapper/src/routes/_layout.html +21 -0
  110. package/demos/webmap-checker-sapper/src/routes/auth/authorize.js +18 -0
  111. package/demos/webmap-checker-sapper/src/routes/auth/exchange-token.js +20 -0
  112. package/demos/webmap-checker-sapper/src/routes/auth/post-sign-in.js +24 -0
  113. package/demos/webmap-checker-sapper/src/routes/auth/sign-out.js +10 -0
  114. package/demos/webmap-checker-sapper/src/routes/index.html +20 -0
  115. package/demos/webmap-checker-sapper/src/routes/webmaps/[webmapId].html +83 -0
  116. package/demos/webmap-checker-sapper/src/routes/webmaps/index.html +59 -0
  117. package/demos/webmap-checker-sapper/src/server.js +101 -0
  118. package/demos/webmap-checker-sapper/src/service-worker.js +82 -0
  119. package/demos/webmap-checker-sapper/src/template.html +33 -0
  120. package/demos/webmap-checker-sapper/src/userInfoMiddleware.js +21 -0
  121. package/demos/webmap-checker-sapper/src/utils.js +33 -0
  122. package/demos/webmap-checker-sapper/static/favicon.png +0 -0
  123. package/demos/webmap-checker-sapper/static/global.css +36 -0
  124. package/demos/webmap-checker-sapper/static/manifest.json +20 -0
  125. package/demos/webmap-checker-sapper/static/svelte-logo-192.png +0 -0
  126. package/demos/webmap-checker-sapper/static/svelte-logo-512.png +0 -0
  127. package/docs/FAQ.md +48 -0
  128. package/docs/HISTORY.md +62 -0
  129. package/docs/acetate.config.js +262 -0
  130. package/docs/build-typedoc.js +434 -0
  131. package/docs/generate-srihashes.js +53 -0
  132. package/docs/src/_layout.html +86 -0
  133. package/docs/src/api/_declaration.html +600 -0
  134. package/docs/src/api/_layout.html +204 -0
  135. package/docs/src/api/_package.html +38 -0
  136. package/docs/src/api/index.html +16 -0
  137. package/docs/src/guides/_layout.html +24 -0
  138. package/docs/src/guides/amd-requirejs-dojo.md +40 -0
  139. package/docs/src/guides/browser-authentication.md +41 -0
  140. package/docs/src/guides/bundlers.md +52 -0
  141. package/docs/src/guides/cli-authentication.md +9 -0
  142. package/docs/src/guides/client-server-authentication.md +9 -0
  143. package/docs/src/guides/embedded-apps.md +93 -0
  144. package/docs/src/guides/from-a-cdn.md +38 -0
  145. package/docs/src/guides/index.md +59 -0
  146. package/docs/src/guides/node.md +87 -0
  147. package/docs/src/guides/package-overview.md +111 -0
  148. package/docs/src/guides/server-authentication.md +9 -0
  149. package/docs/src/guides/whats-new-v2-0.md +305 -0
  150. package/docs/src/img/icons.png +0 -0
  151. package/docs/src/img/icons@2x.png +0 -0
  152. package/docs/src/index.html +12 -0
  153. package/docs/src/js/api-search.js +112 -0
  154. package/docs/src/js/nav-toggle.js +41 -0
  155. package/docs/src/sass/_highlight.scss +96 -0
  156. package/docs/src/sass/_icons.scss +157 -0
  157. package/docs/src/sass/style.scss +242 -0
  158. package/docs/src/srihashes.json +12 -0
  159. package/jasmine.json +7 -0
  160. package/karma.conf.js +106 -0
  161. package/lerna.json +8 -0
  162. package/notes/README.md +68 -0
  163. package/package.json +87 -0
  164. package/packages/arcgis-rest-auth/README.md +71 -0
  165. package/packages/arcgis-rest-auth/package-lock.json +11 -0
  166. package/packages/arcgis-rest-auth/package.json +69 -0
  167. package/packages/arcgis-rest-auth/src/ApplicationSession.ts +122 -0
  168. package/packages/arcgis-rest-auth/src/UserSession.ts +1206 -0
  169. package/packages/arcgis-rest-auth/src/app-tokens.ts +91 -0
  170. package/packages/arcgis-rest-auth/src/authenticated-request-options.ts +24 -0
  171. package/packages/arcgis-rest-auth/src/federation-utils.ts +85 -0
  172. package/packages/arcgis-rest-auth/src/fetch-token.ts +50 -0
  173. package/packages/arcgis-rest-auth/src/generate-token.ts +35 -0
  174. package/packages/arcgis-rest-auth/src/index.ts +9 -0
  175. package/packages/arcgis-rest-auth/src/validate-app-access.ts +68 -0
  176. package/packages/arcgis-rest-auth/test/ApplicationSession.test.ts +124 -0
  177. package/packages/arcgis-rest-auth/test/UserSession.test.ts +1807 -0
  178. package/packages/arcgis-rest-auth/test/app-tokens.test.ts +91 -0
  179. package/packages/arcgis-rest-auth/test/federation-utils.test.ts +323 -0
  180. package/packages/arcgis-rest-auth/test/fetchToken.test.ts +112 -0
  181. package/packages/arcgis-rest-auth/test/generateToken.test.ts +102 -0
  182. package/packages/arcgis-rest-auth/test/utils.ts +14 -0
  183. package/packages/arcgis-rest-auth/test/validate-app-access.test.ts +46 -0
  184. package/packages/arcgis-rest-auth/tsconfig.json +6 -0
  185. package/packages/arcgis-rest-feature-layer/README.md +77 -0
  186. package/packages/arcgis-rest-feature-layer/package-lock.json +11 -0
  187. package/packages/arcgis-rest-feature-layer/package.json +64 -0
  188. package/packages/arcgis-rest-feature-layer/src/add.ts +56 -0
  189. package/packages/arcgis-rest-feature-layer/src/addAttachment.ts +53 -0
  190. package/packages/arcgis-rest-feature-layer/src/applyEdits.ts +90 -0
  191. package/packages/arcgis-rest-feature-layer/src/decodeValues.ts +124 -0
  192. package/packages/arcgis-rest-feature-layer/src/delete.ts +61 -0
  193. package/packages/arcgis-rest-feature-layer/src/deleteAttachments.ts +52 -0
  194. package/packages/arcgis-rest-feature-layer/src/getAttachments.ts +55 -0
  195. package/packages/arcgis-rest-feature-layer/src/getLayer.ts +24 -0
  196. package/packages/arcgis-rest-feature-layer/src/getService.ts +26 -0
  197. package/packages/arcgis-rest-feature-layer/src/helpers.ts +79 -0
  198. package/packages/arcgis-rest-feature-layer/src/index.ts +31 -0
  199. package/packages/arcgis-rest-feature-layer/src/query.ts +204 -0
  200. package/packages/arcgis-rest-feature-layer/src/queryRelated.ts +89 -0
  201. package/packages/arcgis-rest-feature-layer/src/update.ts +56 -0
  202. package/packages/arcgis-rest-feature-layer/src/updateAttachment.ts +59 -0
  203. package/packages/arcgis-rest-feature-layer/test/attachments.test.ts +200 -0
  204. package/packages/arcgis-rest-feature-layer/test/crud.test.ts +195 -0
  205. package/packages/arcgis-rest-feature-layer/test/decodeValues.test.ts +67 -0
  206. package/packages/arcgis-rest-feature-layer/test/getLayer.test.ts +31 -0
  207. package/packages/arcgis-rest-feature-layer/test/getService.test.ts +31 -0
  208. package/packages/arcgis-rest-feature-layer/test/mocks/cvdQueryResponse.ts +225 -0
  209. package/packages/arcgis-rest-feature-layer/test/mocks/feature.ts +302 -0
  210. package/packages/arcgis-rest-feature-layer/test/mocks/fields.ts +779 -0
  211. package/packages/arcgis-rest-feature-layer/test/mocks/foo.txt +1 -0
  212. package/packages/arcgis-rest-feature-layer/test/mocks/service.ts +398 -0
  213. package/packages/arcgis-rest-feature-layer/test/query.test.ts +167 -0
  214. package/packages/arcgis-rest-feature-layer/tsconfig.json +6 -0
  215. package/packages/arcgis-rest-geocoding/README.md +86 -0
  216. package/packages/arcgis-rest-geocoding/package-lock.json +11 -0
  217. package/packages/arcgis-rest-geocoding/package.json +64 -0
  218. package/packages/arcgis-rest-geocoding/src/bulk.ts +104 -0
  219. package/packages/arcgis-rest-geocoding/src/geocode.ts +133 -0
  220. package/packages/arcgis-rest-geocoding/src/helpers.ts +54 -0
  221. package/packages/arcgis-rest-geocoding/src/index.ts +15 -0
  222. package/packages/arcgis-rest-geocoding/src/reverse.ts +84 -0
  223. package/packages/arcgis-rest-geocoding/src/suggest.ts +45 -0
  224. package/packages/arcgis-rest-geocoding/test/bulk.test.ts +194 -0
  225. package/packages/arcgis-rest-geocoding/test/geocode.test.ts +249 -0
  226. package/packages/arcgis-rest-geocoding/test/helpers.test.ts +85 -0
  227. package/packages/arcgis-rest-geocoding/test/mocks/responses.ts +637 -0
  228. package/packages/arcgis-rest-geocoding/test/reverse.test.ts +126 -0
  229. package/packages/arcgis-rest-geocoding/test/suggest.test.ts +53 -0
  230. package/packages/arcgis-rest-geocoding/tsconfig.json +6 -0
  231. package/packages/arcgis-rest-portal/README.md +73 -0
  232. package/packages/arcgis-rest-portal/package-lock.json +11 -0
  233. package/packages/arcgis-rest-portal/package.json +64 -0
  234. package/packages/arcgis-rest-portal/src/groups/add-users.ts +140 -0
  235. package/packages/arcgis-rest-portal/src/groups/create.ts +43 -0
  236. package/packages/arcgis-rest-portal/src/groups/get.ts +184 -0
  237. package/packages/arcgis-rest-portal/src/groups/helpers.ts +14 -0
  238. package/packages/arcgis-rest-portal/src/groups/invite-users.ts +127 -0
  239. package/packages/arcgis-rest-portal/src/groups/join.ts +57 -0
  240. package/packages/arcgis-rest-portal/src/groups/notification.ts +77 -0
  241. package/packages/arcgis-rest-portal/src/groups/protect.ts +56 -0
  242. package/packages/arcgis-rest-portal/src/groups/remove-users.ts +76 -0
  243. package/packages/arcgis-rest-portal/src/groups/remove.ts +32 -0
  244. package/packages/arcgis-rest-portal/src/groups/search.ts +47 -0
  245. package/packages/arcgis-rest-portal/src/groups/update-user-membership.ts +63 -0
  246. package/packages/arcgis-rest-portal/src/groups/update.ts +39 -0
  247. package/packages/arcgis-rest-portal/src/index.ts +66 -0
  248. package/packages/arcgis-rest-portal/src/items/add.ts +138 -0
  249. package/packages/arcgis-rest-portal/src/items/content.ts +67 -0
  250. package/packages/arcgis-rest-portal/src/items/create.ts +150 -0
  251. package/packages/arcgis-rest-portal/src/items/export.ts +80 -0
  252. package/packages/arcgis-rest-portal/src/items/get.ts +437 -0
  253. package/packages/arcgis-rest-portal/src/items/helpers.ts +275 -0
  254. package/packages/arcgis-rest-portal/src/items/protect.ts +41 -0
  255. package/packages/arcgis-rest-portal/src/items/reassign.ts +61 -0
  256. package/packages/arcgis-rest-portal/src/items/remove.ts +135 -0
  257. package/packages/arcgis-rest-portal/src/items/search.ts +25 -0
  258. package/packages/arcgis-rest-portal/src/items/update.ts +184 -0
  259. package/packages/arcgis-rest-portal/src/items/upload.ts +125 -0
  260. package/packages/arcgis-rest-portal/src/orgs/notification.ts +131 -0
  261. package/packages/arcgis-rest-portal/src/sharing/access.ts +84 -0
  262. package/packages/arcgis-rest-portal/src/sharing/helpers.ts +81 -0
  263. package/packages/arcgis-rest-portal/src/sharing/is-item-shared-with-group.ts +42 -0
  264. package/packages/arcgis-rest-portal/src/sharing/share-item-with-group.ts +319 -0
  265. package/packages/arcgis-rest-portal/src/sharing/unshare-item-with-group.ts +105 -0
  266. package/packages/arcgis-rest-portal/src/users/get-user-tags.ts +52 -0
  267. package/packages/arcgis-rest-portal/src/users/get-user-url.ts +18 -0
  268. package/packages/arcgis-rest-portal/src/users/get-user.ts +58 -0
  269. package/packages/arcgis-rest-portal/src/users/invitation.ts +156 -0
  270. package/packages/arcgis-rest-portal/src/users/notification.ts +68 -0
  271. package/packages/arcgis-rest-portal/src/users/search-users.ts +37 -0
  272. package/packages/arcgis-rest-portal/src/users/update.ts +66 -0
  273. package/packages/arcgis-rest-portal/src/util/SearchQueryBuilder.ts +374 -0
  274. package/packages/arcgis-rest-portal/src/util/array.ts +16 -0
  275. package/packages/arcgis-rest-portal/src/util/generic-search.ts +99 -0
  276. package/packages/arcgis-rest-portal/src/util/get-portal-settings.ts +45 -0
  277. package/packages/arcgis-rest-portal/src/util/get-portal-url.ts +27 -0
  278. package/packages/arcgis-rest-portal/src/util/get-portal.ts +52 -0
  279. package/packages/arcgis-rest-portal/src/util/get-subscription-info.ts +43 -0
  280. package/packages/arcgis-rest-portal/src/util/scrub-control-chars.ts +12 -0
  281. package/packages/arcgis-rest-portal/src/util/search.ts +42 -0
  282. package/packages/arcgis-rest-portal/test/groups/add-users.test.ts +239 -0
  283. package/packages/arcgis-rest-portal/test/groups/crud.test.ts +180 -0
  284. package/packages/arcgis-rest-portal/test/groups/get.test.ts +176 -0
  285. package/packages/arcgis-rest-portal/test/groups/invite-users.test.ts +149 -0
  286. package/packages/arcgis-rest-portal/test/groups/join.test.ts +72 -0
  287. package/packages/arcgis-rest-portal/test/groups/notification.test.ts +112 -0
  288. package/packages/arcgis-rest-portal/test/groups/protect.test.ts +72 -0
  289. package/packages/arcgis-rest-portal/test/groups/remove-users.test.ts +140 -0
  290. package/packages/arcgis-rest-portal/test/groups/search.test.ts +151 -0
  291. package/packages/arcgis-rest-portal/test/groups/update-user-membership.test.ts +62 -0
  292. package/packages/arcgis-rest-portal/test/items/add.test.ts +323 -0
  293. package/packages/arcgis-rest-portal/test/items/content.test.ts +156 -0
  294. package/packages/arcgis-rest-portal/test/items/create.test.ts +399 -0
  295. package/packages/arcgis-rest-portal/test/items/export.test.ts +122 -0
  296. package/packages/arcgis-rest-portal/test/items/get.test.ts +583 -0
  297. package/packages/arcgis-rest-portal/test/items/helpers.test.ts +60 -0
  298. package/packages/arcgis-rest-portal/test/items/protect.test.ts +122 -0
  299. package/packages/arcgis-rest-portal/test/items/reassign.test.ts +131 -0
  300. package/packages/arcgis-rest-portal/test/items/remove.test.ts +238 -0
  301. package/packages/arcgis-rest-portal/test/items/search.test.ts +272 -0
  302. package/packages/arcgis-rest-portal/test/items/update.test.ts +554 -0
  303. package/packages/arcgis-rest-portal/test/items/upload.test.ts +282 -0
  304. package/packages/arcgis-rest-portal/test/mocks/groups/responses.ts +208 -0
  305. package/packages/arcgis-rest-portal/test/mocks/items/foo.zip +0 -0
  306. package/packages/arcgis-rest-portal/test/mocks/items/item.ts +526 -0
  307. package/packages/arcgis-rest-portal/test/mocks/items/resources.ts +38 -0
  308. package/packages/arcgis-rest-portal/test/mocks/items/search.ts +121 -0
  309. package/packages/arcgis-rest-portal/test/mocks/portal/response.ts +126 -0
  310. package/packages/arcgis-rest-portal/test/mocks/portal/settings-response.ts +56 -0
  311. package/packages/arcgis-rest-portal/test/mocks/sharing/sharing.ts +18 -0
  312. package/packages/arcgis-rest-portal/test/mocks/users/invitation.ts +70 -0
  313. package/packages/arcgis-rest-portal/test/mocks/users/notification.ts +34 -0
  314. package/packages/arcgis-rest-portal/test/mocks/users/user-search.ts +388 -0
  315. package/packages/arcgis-rest-portal/test/mocks/users/user-tags.ts +5 -0
  316. package/packages/arcgis-rest-portal/test/mocks/users/user.ts +174 -0
  317. package/packages/arcgis-rest-portal/test/orgs/notification.test.ts +142 -0
  318. package/packages/arcgis-rest-portal/test/sharing/access.test.ts +162 -0
  319. package/packages/arcgis-rest-portal/test/sharing/helpers.test.ts +55 -0
  320. package/packages/arcgis-rest-portal/test/sharing/share-item-with-group.test.ts +1325 -0
  321. package/packages/arcgis-rest-portal/test/sharing/unshare-item-with-group.test.ts +288 -0
  322. package/packages/arcgis-rest-portal/test/users/get-user-tags.test.ts +71 -0
  323. package/packages/arcgis-rest-portal/test/users/get-user-url.test.ts +40 -0
  324. package/packages/arcgis-rest-portal/test/users/get-user.test.ts +90 -0
  325. package/packages/arcgis-rest-portal/test/users/invitation.test.ts +127 -0
  326. package/packages/arcgis-rest-portal/test/users/notification.test.ts +77 -0
  327. package/packages/arcgis-rest-portal/test/users/search.test.ts +42 -0
  328. package/packages/arcgis-rest-portal/test/users/update.test.ts +151 -0
  329. package/packages/arcgis-rest-portal/test/util/SearchQueryBuilder.test.ts +340 -0
  330. package/packages/arcgis-rest-portal/test/util/array.test.ts +30 -0
  331. package/packages/arcgis-rest-portal/test/util/get-portal-settings.test.ts +68 -0
  332. package/packages/arcgis-rest-portal/test/util/get-portal-url.test.ts +37 -0
  333. package/packages/arcgis-rest-portal/test/util/portal.test.ts +148 -0
  334. package/packages/arcgis-rest-portal/test/util/scrub-control-chars.test.ts +22 -0
  335. package/packages/arcgis-rest-portal/tsconfig.json +6 -0
  336. package/packages/arcgis-rest-request/README.md +72 -0
  337. package/packages/arcgis-rest-request/package-lock.json +11 -0
  338. package/packages/arcgis-rest-request/package.json +60 -0
  339. package/packages/arcgis-rest-request/src/index.ts +25 -0
  340. package/packages/arcgis-rest-request/src/request.ts +413 -0
  341. package/packages/arcgis-rest-request/src/utils/ArcGISRequestError.ts +76 -0
  342. package/packages/arcgis-rest-request/src/utils/ErrorTypes.ts +29 -0
  343. package/packages/arcgis-rest-request/src/utils/GrantTypes.ts +5 -0
  344. package/packages/arcgis-rest-request/src/utils/HTTPMethods.ts +6 -0
  345. package/packages/arcgis-rest-request/src/utils/IAuthenticationManager.ts +21 -0
  346. package/packages/arcgis-rest-request/src/utils/IFetchTokenParams.ts +11 -0
  347. package/packages/arcgis-rest-request/src/utils/IGenerateTokenParams.ts +9 -0
  348. package/packages/arcgis-rest-request/src/utils/IParamBuilder.ts +3 -0
  349. package/packages/arcgis-rest-request/src/utils/IParams.ts +6 -0
  350. package/packages/arcgis-rest-request/src/utils/IParamsBuilder.ts +5 -0
  351. package/packages/arcgis-rest-request/src/utils/IRequestOptions.ts +49 -0
  352. package/packages/arcgis-rest-request/src/utils/ITokenRequestOptions.ts +9 -0
  353. package/packages/arcgis-rest-request/src/utils/ResponseFormats.ts +10 -0
  354. package/packages/arcgis-rest-request/src/utils/append-custom-params.ts +49 -0
  355. package/packages/arcgis-rest-request/src/utils/clean-url.ts +20 -0
  356. package/packages/arcgis-rest-request/src/utils/decode-query-string.ts +27 -0
  357. package/packages/arcgis-rest-request/src/utils/encode-form-data.ts +38 -0
  358. package/packages/arcgis-rest-request/src/utils/encode-query-string.ts +35 -0
  359. package/packages/arcgis-rest-request/src/utils/process-params.ts +108 -0
  360. package/packages/arcgis-rest-request/src/utils/retryAuthError.ts +10 -0
  361. package/packages/arcgis-rest-request/src/utils/warn.ts +11 -0
  362. package/packages/arcgis-rest-request/src/utils/with-options.ts +48 -0
  363. package/packages/arcgis-rest-request/test/mocks/errors.ts +76 -0
  364. package/packages/arcgis-rest-request/test/mocks/geojson-feature-collection.ts +13 -0
  365. package/packages/arcgis-rest-request/test/mocks/param-builder.ts +7 -0
  366. package/packages/arcgis-rest-request/test/mocks/sharing-rest-info.ts +41 -0
  367. package/packages/arcgis-rest-request/test/mocks/webmap.ts +41 -0
  368. package/packages/arcgis-rest-request/test/request.test.ts +571 -0
  369. package/packages/arcgis-rest-request/test/utils/ArcGISAuthError.test.ts +191 -0
  370. package/packages/arcgis-rest-request/test/utils/ArcGISRequestError.test.ts +51 -0
  371. package/packages/arcgis-rest-request/test/utils/check-for-errors.test.ts +111 -0
  372. package/packages/arcgis-rest-request/test/utils/clean-url.test.ts +50 -0
  373. package/packages/arcgis-rest-request/test/utils/encode-form-data.test.ts +133 -0
  374. package/packages/arcgis-rest-request/test/utils/encode-query-string.test.ts +18 -0
  375. package/packages/arcgis-rest-request/test/utils/process-params.test.ts +205 -0
  376. package/packages/arcgis-rest-request/test/utils/with-options.test.ts +133 -0
  377. package/packages/arcgis-rest-request/tsconfig.json +4 -0
  378. package/packages/arcgis-rest-routing/README.md +75 -0
  379. package/packages/arcgis-rest-routing/package-lock.json +11 -0
  380. package/packages/arcgis-rest-routing/package.json +63 -0
  381. package/packages/arcgis-rest-routing/src/helpers.ts +16 -0
  382. package/packages/arcgis-rest-routing/src/index.ts +11 -0
  383. package/packages/arcgis-rest-routing/src/solveRoute.ts +124 -0
  384. package/packages/arcgis-rest-routing/test/mocks/responses.ts +825 -0
  385. package/packages/arcgis-rest-routing/test/solveRoute.test.ts +509 -0
  386. package/packages/arcgis-rest-routing/tsconfig.json +6 -0
  387. package/packages/arcgis-rest-service-admin/README.md +73 -0
  388. package/packages/arcgis-rest-service-admin/package-lock.json +11 -0
  389. package/packages/arcgis-rest-service-admin/package.json +65 -0
  390. package/packages/arcgis-rest-service-admin/src/addTo.ts +70 -0
  391. package/packages/arcgis-rest-service-admin/src/create.ts +189 -0
  392. package/packages/arcgis-rest-service-admin/src/index.ts +11 -0
  393. package/packages/arcgis-rest-service-admin/src/update.ts +50 -0
  394. package/packages/arcgis-rest-service-admin/test/addTo.test.ts +350 -0
  395. package/packages/arcgis-rest-service-admin/test/create.test.ts +294 -0
  396. package/packages/arcgis-rest-service-admin/test/mocks/layerDefinition.ts +79 -0
  397. package/packages/arcgis-rest-service-admin/test/mocks/service.ts +81 -0
  398. package/packages/arcgis-rest-service-admin/test/update.test.ts +115 -0
  399. package/packages/arcgis-rest-service-admin/tsconfig.json +6 -0
  400. package/packages/arcgis-rest-types/README.md +66 -0
  401. package/packages/arcgis-rest-types/package.json +54 -0
  402. package/packages/arcgis-rest-types/src/feature.ts +39 -0
  403. package/packages/arcgis-rest-types/src/geometry.ts +272 -0
  404. package/packages/arcgis-rest-types/src/group.ts +72 -0
  405. package/packages/arcgis-rest-types/src/index.ts +9 -0
  406. package/packages/arcgis-rest-types/src/item.ts +81 -0
  407. package/packages/arcgis-rest-types/src/service.ts +114 -0
  408. package/packages/arcgis-rest-types/src/statisticDefinition.ts +33 -0
  409. package/packages/arcgis-rest-types/src/symbol.ts +170 -0
  410. package/packages/arcgis-rest-types/src/user.ts +49 -0
  411. package/packages/arcgis-rest-types/src/webmap.ts +1367 -0
  412. package/packages/arcgis-rest-types/tsconfig.json +10 -0
  413. package/support/changelog.js +393 -0
  414. package/support/deploy-doc-site.js +16 -0
  415. package/support/dev.sh +6 -0
  416. package/support/publish.sh +47 -0
  417. package/support/test-helpers.js +9 -0
  418. package/tsconfig.json +63 -0
  419. package/tslint.json +16 -0
  420. package/umd-base-profile.js +81 -0
  421. package/umd-production-profile.js +13 -0
@@ -0,0 +1,600 @@
1
+ {% macro @type(type, isArray, isRest) -%}
2
+ {%- if type.type === 'stringLiteral' -%}
3
+ <span class="text-green">"{{type.value}}"</span>
4
+ {%- endif -%}
5
+
6
+ {%- if type.declaration and type.declaration.children -%}
7
+ {<dl class="type-child-list clearfix">
8
+ {%- for child in type.declaration.children -%}
9
+ <dt class="type-child-name">{{child.name}}:</dt><dd class="type-child-type">{{ @type(child.type) }}</dd>
10
+ {%- endfor -%}
11
+ </dl>}
12
+ {%- endif -%}
13
+
14
+ {%- if type.type === 'array' and (type.elementType.type === "union" or (type.elementType.type === "typeParameter" and type.elementType.constraint.type === "union")) -%}
15
+ <i class="no-wrap">{{ @type(type.elementType, true) }}</i>
16
+ {%- elif type.type === 'array' -%}
17
+ <i class="no-wrap">{{ @type(type.elementType) }}<span class="text-light-gray">{{ '[]' }}</span></i>
18
+ {%- endif -%}
19
+
20
+ {%- if type.type === 'array' -%}
21
+ <span class="text-light-gray">{{ ' | ' }}</span>{{ @type(type.elementType) }}
22
+ {%- endif -%}
23
+
24
+ {%- if type.type === 'intrinsic' -%}
25
+ <i class="text-purple">{{type.name}}</i>
26
+ {%- endif -%}
27
+
28
+ {%- if type.type === 'reference' and type.id and API_TOOLS.findById(data.typedoc, type.id) -%}
29
+ <i><a href="{{ API_TOOLS.findById(data.typedoc, type.id).pageUrl }}">{{type.name}}</a></i>
30
+ {%- elif API_TOOLS.findByName(data.typedoc, type.name) -%}
31
+ <i><a href="{{ API_TOOLS.findByName(data.typedoc, type.name).pageUrl }}">{{type.name}}</a></i>
32
+ {%- elif type.type === 'reference' -%}
33
+ <i>{{type.name}}</i>
34
+ {%- endif -%}
35
+
36
+ {%- if type.type === 'reflection' and type.declaration.signatures.length > 0 -%}
37
+ <span class="code-face"><span class="text-light-gray">function</span><span class="text-light-gray">(</span>{{ @signatureParams(type.declaration.signatures[0].parameters) }}<span class="text-light-gray">) : </span>{{@type(type.declaration.signatures[0].type)}}</span>
38
+ {%- elif type.type === 'reflection' and type.declaration.id and API_TOOLS.findById(data.typedoc, type.declaration.id) -%}
39
+ {% set declaration = API_TOOLS.findById(data.typedoc, type.declaration.id) %}
40
+ <i><a href="{{ declaration.pageUrl }}">{{declaration.name}}</a></i>
41
+ {%- elif type.type === 'reflection' and type.declaration and type.declaration.indexSignature -%}
42
+ {% for signature in type.declaration.indexSignature %}
43
+ <i class="no-wrap">{% for param in signature.parameters%}[key: {{@type(param.type)}}]: {% endfor %}{{@type(signature.type)}}</i>
44
+ {% endfor %}
45
+ {%- elif type.type === 'reflection' -%}
46
+ <i>{{ type.name }}</i>
47
+ {%- endif -%}
48
+
49
+ {%- if type.type === 'union' -%}
50
+ <i>{%- for t in type.types -%}
51
+ {{ @type(t) }}{% if isArray %}<span class="text-light-gray">{{ '[]' }}</span>{% endif %}
52
+
53
+ {%- if (loop.last === false) -%}
54
+ <span class="text-light-gray">{{ ' | ' }}</span>
55
+ {%- endif -%}
56
+ {%- endfor -%}</i>
57
+ {%- endif -%}
58
+
59
+ {%- if type.type === 'tuple' -%}
60
+ <i class="no-wrap">{%- for t in type.elements -%}
61
+ {%- if (loop.first) -%}
62
+ <span class="text-light-gray">{{ '[' }}</span>
63
+ {%- endif -%}
64
+ {{ @type(t) }}
65
+ {%- if (loop.last === false) -%}
66
+ <span class="text-light-gray">{{ ', ' }}</span>
67
+ {%- endif -%}
68
+ {%- if (loop.last) -%}
69
+ <span class="text-light-gray">{{ ']' }}</span>
70
+ {%- endif -%}
71
+ {%- endfor -%}</i>
72
+ {%- endif -%}
73
+
74
+ {%- if type.type === 'typeParameter' and type.constraint -%}
75
+ {{ @type(type.constraint, isArray) }}
76
+ {%- endif -%}
77
+
78
+ {%- if type.typeArguments -%}
79
+ <i>{% for arg in type.typeArguments -%}
80
+ {%- if (loop.first) -%}<span class="text-light-gray">{{ '<' }}</span>{%- endif -%}
81
+ {{ @type(arg) }}
82
+ {%- if (loop.last) -%}<span class="text-light-gray">{{ '>' }}</span>{%- endif -%}
83
+ {%- endfor %}</i>
84
+ {%- endif -%}
85
+ {%- endmacro %}
86
+
87
+ {% macro @param(param) -%}
88
+ {%- if param -%}
89
+ {{param.name}}: {{@type(param.type, undefined, param.flags.isRest)}}
90
+ {%- endif -%}
91
+ {%- endmacro %}
92
+
93
+ {% macro @signatureParams(params) -%}
94
+ {% for param in params | stripThisFromParams -%}{{ @param(param) }}{{ ', ' if (loop.last === false)}}{%- endfor %}
95
+ {%- endmacro %}
96
+
97
+ {% macro @signature(signature) -%}
98
+ <li class="code-face tsd-signature tsd-kind-icon trailer-0 leader-0">{{ signature.name }}<span class="text-light-gray">(</span>{{ @signatureParams(signature.parameters) }}<span class="text-light-gray">) : </span>{{@type(signature.type)}}</li>
99
+ {%- endmacro %}
100
+
101
+ {% macro @inherited(inheritedFrom) -%}
102
+ {% if inheritedFrom %}
103
+ <span class="label">Inherited</span>
104
+ {% endif %}
105
+ {%- endmacro %}
106
+
107
+ {% macro @propertyTableForId (id, header, column1Header, column2Header)%}
108
+ {% if header %}
109
+ <h2 class="font-size-1 trailer-half">{{header | safe}}</h2>
110
+ {% endif %}
111
+ <div class="overflow-auto trailer-1">
112
+ <table class="table">
113
+ <thead>
114
+ <tr>
115
+ <th>{{column1Header}}</th>
116
+ <th>{{column2Header}}</th>
117
+ <th>Notes</th>
118
+ </tr>
119
+ </thead>
120
+ <tbody>
121
+ {% for child in API_TOOLS.findById(data.typedoc, id).children %}
122
+ <tr id="{{child.name}}">
123
+ <td class="code-face {{child.icon}} no-wrap">
124
+ <a href="#{{child.name}}" class="table-link">
125
+ <svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M28.633 17.945l-4.118-4.426c.076 1.131-.034 2.262-.355 3.241l2.83 2.827a5.281 5.281 0 0 1 0 7.459 5.223 5.223 0 0 1-3.723 1.54 5.227 5.227 0 0 1-3.728-1.542l-5.459-5.459a5.276 5.276 0 0 1 0-7.452c.607-.609 1.361-1.048 2.1-1.229a1.833 1.833 0 0 0-.279-.414l-1.344-1.461c-.845.404-1.54.881-2.12 1.461a7.554 7.554 0 0 0-2.223 5.371c0 2.027.791 3.934 2.223 5.366l5.459 5.459a7.544 7.544 0 0 0 5.371 2.225 7.55 7.55 0 0 0 5.366-2.223c2.962-2.962 2.962-7.782 0-10.745zM8.711 3.497a5.23 5.23 0 0 1 3.726 1.54l5.459 5.457a5.279 5.279 0 0 1 0 7.454c-.605.605-1.356 1.043-2.105 1.222.086.154.166.301.287.421l1.422 1.422c.808-.394 1.476-.862 2.039-1.422 2.96-2.962 2.96-7.777 0-10.74L14.08 3.394c-1.434-1.435-3.342-2.225-5.369-2.225s-3.934.791-5.369 2.225C1.908 4.828 1.117 6.736 1.117 8.763s.791 3.934 2.225 5.369L7.46 18.56c-.076-1.131.034-2.262.355-3.239l-2.83-2.833c-.994-.991-1.542-2.316-1.542-3.726s.548-2.732 1.542-3.726a5.23 5.23 0 0 1 3.726-1.54z"/></svg>
126
+ </a>
127
+ <span class="tsd-kind-icon">{{child.name}}</span>
128
+ {{ @flags(child.flags) }}
129
+ {{ @inherited(child.inheritedFrom) }}
130
+ </td>
131
+ <td class="code-face">
132
+ {% if child.defaultValue %}
133
+ {{ child.defaultValue }}
134
+ {% elif child.getSignature %}
135
+ {{ @type(child.getSignature[0].type) }}
136
+ {% else %}
137
+ {{ @type(child.type) }}
138
+ {% endif %}
139
+ </td>
140
+ <td class="body-face api-param-comment">
141
+ {% markdown -%}
142
+ {{ child.comment.shortText | safe | trim }}
143
+ {%- endmarkdown %}
144
+ </td>
145
+ </tr>
146
+ {% endfor %}
147
+
148
+ </tbody>
149
+ </table>
150
+ </div>
151
+ {% endmacro %}
152
+
153
+ {% macro @properties (group, children) %}
154
+ <div class="overflow-auto trailer-1">
155
+ <table class="table">
156
+ <thead>
157
+ <tr>
158
+ <th>{{ API_TOOLS.findChildById(group.children[0], children).kindString }}</th>
159
+ <th>{{ 'Value' if API_TOOLS.findChildById(group.children[0], children).defaultValue else 'Type' }}</th>
160
+ <th>Notes</th>
161
+ </tr>
162
+ </thead>
163
+ <tbody>
164
+ {% for id in group.children %}
165
+ {% set child = API_TOOLS.findChildById(id, children) %}
166
+ <tr id="{{child.name}}">
167
+ <td class="code-face {{child.icon}} no-wrap">
168
+ <a href="#{{child.name}}" class="table-link">
169
+ <svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M28.633 17.945l-4.118-4.426c.076 1.131-.034 2.262-.355 3.241l2.83 2.827a5.281 5.281 0 0 1 0 7.459 5.223 5.223 0 0 1-3.723 1.54 5.227 5.227 0 0 1-3.728-1.542l-5.459-5.459a5.276 5.276 0 0 1 0-7.452c.607-.609 1.361-1.048 2.1-1.229a1.833 1.833 0 0 0-.279-.414l-1.344-1.461c-.845.404-1.54.881-2.12 1.461a7.554 7.554 0 0 0-2.223 5.371c0 2.027.791 3.934 2.223 5.366l5.459 5.459a7.544 7.544 0 0 0 5.371 2.225 7.55 7.55 0 0 0 5.366-2.223c2.962-2.962 2.962-7.782 0-10.745zM8.711 3.497a5.23 5.23 0 0 1 3.726 1.54l5.459 5.457a5.279 5.279 0 0 1 0 7.454c-.605.605-1.356 1.043-2.105 1.222.086.154.166.301.287.421l1.422 1.422c.808-.394 1.476-.862 2.039-1.422 2.96-2.962 2.96-7.777 0-10.74L14.08 3.394c-1.434-1.435-3.342-2.225-5.369-2.225s-3.934.791-5.369 2.225C1.908 4.828 1.117 6.736 1.117 8.763s.791 3.934 2.225 5.369L7.46 18.56c-.076-1.131.034-2.262.355-3.239l-2.83-2.833c-.994-.991-1.542-2.316-1.542-3.726s.548-2.732 1.542-3.726a5.23 5.23 0 0 1 3.726-1.54z"/></svg>
170
+ </a>
171
+ <span class="tsd-kind-icon">{{child.name}}</span>
172
+ {{ @flags(child.flags) }}
173
+ {{ @inherited(child.inheritedFrom) }}
174
+ </td>
175
+ <td class="code-face">
176
+ {% if child.defaultValue %}
177
+ {{ child.defaultValue }}
178
+ {% elif child.getSignature %}
179
+ {{ @type(child.getSignature[0].type) }}
180
+ {% else %}
181
+ {{ @type(child.type) }}
182
+ {% endif %}
183
+ </td>
184
+ <td class="body-face api-param-comment">
185
+ {% markdown -%}
186
+ {{ child.comment.shortText | safe | trim }}
187
+ {%- endmarkdown %}
188
+ </td>
189
+ </tr>
190
+ {% endfor %}
191
+
192
+ </tbody>
193
+ </table>
194
+ </div>
195
+ {% endmacro %}
196
+
197
+ {% macro @indexSignature (signatures, parentKind) %}
198
+ <div class="overflow-auto trailer-1">
199
+ <table class="table">
200
+ <thead>
201
+ <tr>
202
+ <th>Key Type</th>
203
+ <th>Value Type</th>
204
+ <th>Notes</th>
205
+ </tr>
206
+ </thead>
207
+ <tbody>
208
+ {% for child in signatures %}
209
+ <tr id="{{child.parameters[0].id}}">
210
+ <td class="code-face tsd-kind-index-signature tsd-parent-kind-{{parentKind | lower}} no-wrap">
211
+ <a href="#{{child.parameters[0].id}}" class="table-link">
212
+ <svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M28.633 17.945l-4.118-4.426c.076 1.131-.034 2.262-.355 3.241l2.83 2.827a5.281 5.281 0 0 1 0 7.459 5.223 5.223 0 0 1-3.723 1.54 5.227 5.227 0 0 1-3.728-1.542l-5.459-5.459a5.276 5.276 0 0 1 0-7.452c.607-.609 1.361-1.048 2.1-1.229a1.833 1.833 0 0 0-.279-.414l-1.344-1.461c-.845.404-1.54.881-2.12 1.461a7.554 7.554 0 0 0-2.223 5.371c0 2.027.791 3.934 2.223 5.366l5.459 5.459a7.544 7.544 0 0 0 5.371 2.225 7.55 7.55 0 0 0 5.366-2.223c2.962-2.962 2.962-7.782 0-10.745zM8.711 3.497a5.23 5.23 0 0 1 3.726 1.54l5.459 5.457a5.279 5.279 0 0 1 0 7.454c-.605.605-1.356 1.043-2.105 1.222.086.154.166.301.287.421l1.422 1.422c.808-.394 1.476-.862 2.039-1.422 2.96-2.962 2.96-7.777 0-10.74L14.08 3.394c-1.434-1.435-3.342-2.225-5.369-2.225s-3.934.791-5.369 2.225C1.908 4.828 1.117 6.736 1.117 8.763s.791 3.934 2.225 5.369L7.46 18.56c-.076-1.131.034-2.262.355-3.239l-2.83-2.833c-.994-.991-1.542-2.316-1.542-3.726s.548-2.732 1.542-3.726a5.23 5.23 0 0 1 3.726-1.54z"/></svg>
213
+ </a>
214
+ <span class="tsd-kind-icon">{{ @type(child.parameters[0].type) }}</span>
215
+ </td>
216
+ <td class="code-face">
217
+ {% if child.defaultValue %}
218
+ {{ child.defaultValue }}
219
+ {% elif child.getSignature %}
220
+ {{ @type(child.getSignature[0].type) }}
221
+ {% else %}
222
+ {{ @type(child.type) }}
223
+ {% endif %}
224
+ </td>
225
+ <td class="body-face api-param-comment">
226
+ {% markdown -%}
227
+ {{ child.comment.shortText | safe | trim }}
228
+ {%- endmarkdown %}
229
+ </td>
230
+ </tr>
231
+ {% endfor %}
232
+
233
+ </tbody>
234
+ </table>
235
+ </div>
236
+ {% endmacro %}
237
+
238
+ {% macro @flags(flags) %}
239
+ {% if flags.isOptional %}
240
+ <span class="label">Optional</span>
241
+ {% endif %}
242
+
243
+ {% if flags.isPrivate %}
244
+ <span class="label">Private</span>
245
+ {% endif %}
246
+
247
+ {% if flags.isProtected %}
248
+ <span class="label">Protected</span>
249
+ {% endif %}
250
+
251
+ {% if flags.isRequired %}
252
+ <span class="label">Required</span>
253
+ {% endif %}
254
+
255
+ {% if flags.isStatic %}
256
+ <span class="label">Static</span>
257
+ {% endif %}
258
+ {% endmacro %}
259
+
260
+ {% macro @signatures(signatures) %}
261
+ {%- if signatures[0].comment.shortText -%}
262
+ {% markdown -%}
263
+ {{ signatures[0].comment.shortText | safe }}
264
+ {%- endmarkdown %}
265
+ {%- endif %}
266
+
267
+ {% if signatures[0].comment.text %}
268
+ {% markdown -%}
269
+ {{ signatures[0].comment.text | safe }}
270
+ {%- endmarkdown %}
271
+ {% endif %}
272
+
273
+ <div class="panel padding-leader-half padding-trailer-half padding-right-quarter padding-left-half trailer-half">
274
+ <ul class="list-plain tsd-signatures {{icon}} trailer-0 leader-0">
275
+ {% for signature in signatures %}
276
+ {{ @signature(signature) }}
277
+ {% endfor %}
278
+ </ul>
279
+ </div>
280
+
281
+ {% if signatures[0].parameters %}
282
+ <h2 class="font-size-1 trailer-half">Parameters</h2>
283
+ {{@parametersTable(signatures[0].parameters, signatures[0].name)}}
284
+ {% endif %}
285
+
286
+ {% for param in signatures[0].parameters %}
287
+ {% if param.name == "requestOptions" and param.type.type === "reference" %}
288
+ {% set id = API_TOOLS.findByName(data.typedoc, param.type.name).id %}
289
+ {{ @propertyTableForId(id, "Available <code>requestOptions</code>", "Property", "Type")}}
290
+ {% endif %}
291
+
292
+ {% if param.name == "requestOptions" and param.type.type !== "reference" and param.type.id %}
293
+ {{ @propertyTableForId(param.type.id, "Options", "Property", "Type")}}
294
+ {% endif %}
295
+ {% endfor %}
296
+
297
+ <h2 class="font-size-1 trailer-half">Returns</h2>
298
+
299
+ {%- markdown -%}
300
+ {{ signatures[0].comment.returns | safe }}
301
+ {%- endmarkdown %}
302
+
303
+ <div class="fonts-size--1 panel padding-leader-half padding-trailer-half padding-right-half padding-left-half trailer-half">
304
+ {{@type(signatures[0].type)}}
305
+ </div>
306
+
307
+ {% if (signatures[0].type.name === "Promise" and signatures[0].type.typeArguments[0].type === "reference") %}
308
+ {% set id = API_TOOLS.findByName(data.typedoc, signatures[0].type.typeArguments[0].name).id %}
309
+ {{ @propertyTableForId(id, undefined, "Property", "Type") }}
310
+ {% elif (signatures[0].type.name === "Promise" and signatures[0].type.typeArguments[0].id) or signatures[0].type.id %}
311
+ {% set id = signatures[0].type.typeArguments[0].id or signatures[0].type.id %}
312
+ {{ @propertyTableForId(id, undefined, "Property", "Type") }}
313
+ {% endif %}
314
+ {% endmacro %}
315
+
316
+ {% macro @methodsTable(group, children) %}
317
+ <div class="overflow-auto trailer-1">
318
+ <table class="table">
319
+ <thead>
320
+ <tr>
321
+ <th>Method</th>
322
+ <th>Returns</th>
323
+ <th>Notes</th>
324
+ </tr>
325
+ </thead>
326
+ <tbody>
327
+ {% for childId in group.children %}
328
+ {% set child = API_TOOLS.findChildById(childId, children) %}
329
+ <tr id="{{child.signatures[0].name}}-summary">
330
+ <td>
331
+ <a href="#{{child.signatures[0].name}}-summary" class="table-link">
332
+ <svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M28.633 17.945l-4.118-4.426c.076 1.131-.034 2.262-.355 3.241l2.83 2.827a5.281 5.281 0 0 1 0 7.459 5.223 5.223 0 0 1-3.723 1.54 5.227 5.227 0 0 1-3.728-1.542l-5.459-5.459a5.276 5.276 0 0 1 0-7.452c.607-.609 1.361-1.048 2.1-1.229a1.833 1.833 0 0 0-.279-.414l-1.344-1.461c-.845.404-1.54.881-2.12 1.461a7.554 7.554 0 0 0-2.223 5.371c0 2.027.791 3.934 2.223 5.366l5.459 5.459a7.544 7.544 0 0 0 5.371 2.225 7.55 7.55 0 0 0 5.366-2.223c2.962-2.962 2.962-7.782 0-10.745zM8.711 3.497a5.23 5.23 0 0 1 3.726 1.54l5.459 5.457a5.279 5.279 0 0 1 0 7.454c-.605.605-1.356 1.043-2.105 1.222.086.154.166.301.287.421l1.422 1.422c.808-.394 1.476-.862 2.039-1.422 2.96-2.962 2.96-7.777 0-10.74L14.08 3.394c-1.434-1.435-3.342-2.225-5.369-2.225s-3.934.791-5.369 2.225C1.908 4.828 1.117 6.736 1.117 8.763s.791 3.934 2.225 5.369L7.46 18.56c-.076-1.131.034-2.262.355-3.239l-2.83-2.833c-.994-.991-1.542-2.316-1.542-3.726s.548-2.732 1.542-3.726a5.23 5.23 0 0 1 3.726-1.54z"/></svg>
333
+ </a>
334
+ <ul class="method-table-signatures {{child.signatures[0].icon}}">
335
+ {% for signature in child.signatures -%}
336
+ <li class="code-face tsd-signature tsd-kind-icon">
337
+ <a href="#{{signature.name}}">{{ signature.name }}</a><span class="text-light-gray">(</span>{{ @signatureParams(signature.parameters) }}<span class="text-light-gray">)</span>
338
+ </li>
339
+ {%- endfor %}
340
+ </ul>
341
+ </td>
342
+ <td class="code-face">{{@type(child.signatures[0].type)}}</td>
343
+ <td class="body-face api-param-comment">
344
+ {% markdown -%}
345
+ {{ child.signatures[0].comment.shortText | safe | trim }}
346
+ {%- endmarkdown %}
347
+ {% markdown -%}
348
+ {{ child.signatures[0].comment.text | safe | trim }}
349
+ {%- endmarkdown %}
350
+ </td>
351
+ </tr>
352
+ {% endfor %}
353
+ </tbody>
354
+ </table>
355
+ </div>
356
+
357
+ {% for childId in group.children %}
358
+ {% set child = API_TOOLS.findChildById(childId, children) %}
359
+ {% set signatures = child.signatures %}
360
+ <div id="{{signatures[0].name}}" class="method-panel panel panel-white padding-trailer-0 leader-1 trailer-1">
361
+ <header class="clearfix">
362
+ <a href="#{{signatures[0].name}}" class="table-link">
363
+ <svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M28.633 17.945l-4.118-4.426c.076 1.131-.034 2.262-.355 3.241l2.83 2.827a5.281 5.281 0 0 1 0 7.459 5.223 5.223 0 0 1-3.723 1.54 5.227 5.227 0 0 1-3.728-1.542l-5.459-5.459a5.276 5.276 0 0 1 0-7.452c.607-.609 1.361-1.048 2.1-1.229a1.833 1.833 0 0 0-.279-.414l-1.344-1.461c-.845.404-1.54.881-2.12 1.461a7.554 7.554 0 0 0-2.223 5.371c0 2.027.791 3.934 2.223 5.366l5.459 5.459a7.544 7.544 0 0 0 5.371 2.225 7.55 7.55 0 0 0 5.366-2.223c2.962-2.962 2.962-7.782 0-10.745zM8.711 3.497a5.23 5.23 0 0 1 3.726 1.54l5.459 5.457a5.279 5.279 0 0 1 0 7.454c-.605.605-1.356 1.043-2.105 1.222.086.154.166.301.287.421l1.422 1.422c.808-.394 1.476-.862 2.039-1.422 2.96-2.962 2.96-7.777 0-10.74L14.08 3.394c-1.434-1.435-3.342-2.225-5.369-2.225s-3.934.791-5.369 2.225C1.908 4.828 1.117 6.736 1.117 8.763s.791 3.934 2.225 5.369L7.46 18.56c-.076-1.131.034-2.262.355-3.239l-2.83-2.833c-.994-.991-1.542-2.316-1.542-3.726s.548-2.732 1.542-3.726a5.23 5.23 0 0 1 3.726-1.54z"/></svg>
364
+ </a>
365
+ <h3 class="font-size-2 code-face trailer-0 margin-right-half left">{{signatures[0].name}}</h3>
366
+ {{ @flags(child.flags)}}
367
+ <small class="{{signatures[0].icon}} font-size--2 right">
368
+ <span class="tsd-kind-icon">
369
+ {% if child.flags.isStatic %}
370
+ Static {{kindString}} Method
371
+ {% elif child.flags.isPrivate %}
372
+ Private {{kindString}} Method
373
+ {% elif child.flags.isProtected %}
374
+ Protected {{kindString}} Method
375
+ {% else %}
376
+ {{kindString}} Method
377
+ {% endif %}
378
+ </span>
379
+ </small>
380
+ </header>
381
+
382
+ <hr class="leader-half trailer-half">
383
+
384
+ <div class="api-function-comment">
385
+ {% markdown -%}
386
+ {{ signatures[0].comment.shortText | safe }}
387
+ {%- endmarkdown %}
388
+ </div>
389
+
390
+ <div class="fonts-size--1 panel padding-leader-half padding-trailer-half padding-right-half padding-left-half trailer-half">
391
+ <ul class="list-plain trailer-0 tsd-signatures trailer-half {{signatures[0].icon}}">
392
+ {% for signature in signatures %}
393
+ {{ @signature(signature) }}
394
+ {% endfor %}
395
+ </ul>
396
+ </div>
397
+
398
+ {% if (signatures[0].parameters | stripThisFromParams).length > 0 %}
399
+ <h2 class="font-size-1 trailer-half">Parameters</h2>
400
+ {{@parametersTable(signatures[0].parameters, signatures[0].name)}}
401
+ {% endif %}
402
+
403
+ <h2 class="font-size-1 trailer-half">Returns</h2>
404
+
405
+ {%- markdown -%}
406
+ {{ signatures[0].comment.returns | safe }}
407
+ {%- endmarkdown %}
408
+
409
+ <div class="fonts-size--1 panel padding-leader-half padding-trailer-half padding-right-half padding-left-half trailer-half">
410
+ {{@type(signatures[0].type)}}
411
+ </div>
412
+
413
+ {% if signatures[0].comment.text %}
414
+ <hr class="leader-half trailer-half">
415
+
416
+ {% markdown -%}
417
+ {{ signatures[0].comment.text | safe }}
418
+ {%- endmarkdown %}
419
+ {% endif %}
420
+ </div>
421
+ {% endfor %}
422
+ {% endmacro %}
423
+
424
+ {% macro @accessorsTable(group, children) %}
425
+ {{ @properties(group, children) }}
426
+ {# @TODO make a custom table when and if we need setters... #}
427
+ {% endmacro %}
428
+
429
+ {% macro @parametersTable(parameters, fnName) %}
430
+ <div class="overflow-auto trailer-1">
431
+ <table class="table">
432
+ <thead>
433
+ <tr>
434
+ <th class="font-size--2">Parameter</th>
435
+ <th class="font-size--2">Type</th>
436
+ <th class="font-size--2">Default</th>
437
+ <th class="font-size--2">Notes</th>
438
+ </tr>
439
+ </thead>
440
+ <tbody>
441
+ {% for param in parameters | stripThisFromParams -%}
442
+ <tr id="{{fnName}}-{{param.name}}">
443
+ <td class="code-face">
444
+ <a href="#{{fnName}}-{{param.name}}" class="table-link">
445
+ <svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32" class="svg-icon"><path d="M28.633 17.945l-4.118-4.426c.076 1.131-.034 2.262-.355 3.241l2.83 2.827a5.281 5.281 0 0 1 0 7.459 5.223 5.223 0 0 1-3.723 1.54 5.227 5.227 0 0 1-3.728-1.542l-5.459-5.459a5.276 5.276 0 0 1 0-7.452c.607-.609 1.361-1.048 2.1-1.229a1.833 1.833 0 0 0-.279-.414l-1.344-1.461c-.845.404-1.54.881-2.12 1.461a7.554 7.554 0 0 0-2.223 5.371c0 2.027.791 3.934 2.223 5.366l5.459 5.459a7.544 7.544 0 0 0 5.371 2.225 7.55 7.55 0 0 0 5.366-2.223c2.962-2.962 2.962-7.782 0-10.745zM8.711 3.497a5.23 5.23 0 0 1 3.726 1.54l5.459 5.457a5.279 5.279 0 0 1 0 7.454c-.605.605-1.356 1.043-2.105 1.222.086.154.166.301.287.421l1.422 1.422c.808-.394 1.476-.862 2.039-1.422 2.96-2.962 2.96-7.777 0-10.74L14.08 3.394c-1.434-1.435-3.342-2.225-5.369-2.225s-3.934.791-5.369 2.225C1.908 4.828 1.117 6.736 1.117 8.763s.791 3.934 2.225 5.369L7.46 18.56c-.076-1.131.034-2.262.355-3.239l-2.83-2.833c-.994-.991-1.542-2.316-1.542-3.726s.548-2.732 1.542-3.726a5.23 5.23 0 0 1 3.726-1.54z"/></svg>
446
+ </a>
447
+ <span class="code-face">{{param.name}}</span>
448
+ {% if param.defaultValue %}
449
+ {{ @flags({isOptional: true}) }}
450
+ {% elif not param.defaultValue and not param.flags.isOptional %}
451
+ {{ @flags({isRequired: true}) }}
452
+ {% else %}
453
+ {{ @flags(param.flags) }}
454
+ {% endif %}
455
+ </td>
456
+ <td class="code-face">{{@type(param.type)}}</td>
457
+ <td class="code-face">{{param.defaultValue}}</td>
458
+ <td class="body-face api-param-comment">
459
+ {% markdown -%}
460
+ {{ param.comment.shortText | safe | trim }}
461
+ {%- endmarkdown %}
462
+ {% markdown -%}
463
+ {{ param.comment.text | safe | trim }}
464
+ {%- endmarkdown %}
465
+ </td>
466
+ </tr>
467
+ {%- endfor %}
468
+ </tbody>
469
+ </table>
470
+ </div>
471
+ {% endmacro %}
472
+
473
+ <div class="clearfix trailer-half">
474
+ <h1 class="left font-size-5 code-face trailer-0">{{name}}</h1>
475
+ <small class="{{icon}} font-size--2 right leader-half margin-right-half"><span class="tsd-kind-icon">{{kindString}}</span></small>
476
+ </div>
477
+
478
+ {% if comment %}
479
+ {% markdown -%}
480
+ {{ comment.shortText | safe }}
481
+ {%- endmarkdown %}
482
+ {% endif %}
483
+
484
+ {% if comment and comment.text %}
485
+ {% markdown -%}
486
+ {{ comment.text | safe }}
487
+ {%- endmarkdown %}
488
+ {% endif %}
489
+
490
+ {% if implementedTypes %}
491
+ <h2>Implements</h2>
492
+ <ul class="list-plain trailer-1">
493
+ {% for implementedType in implementedTypes %}
494
+ {% if implementedType.id %}
495
+ {% set base = API_TOOLS.findById(data.typedoc, implementedType.id) %}
496
+ <li class="code-face {{base.icon}}"><a href="{{ base.pageUrl }}" class="tsd-kind-icon">{{base.name}}</a></li>
497
+ {% elif implementedType.name %}
498
+ {% set base = API_TOOLS.findByName(data.typedoc, implementedType.name) %}
499
+ {% if base %}
500
+ <li class="code-face {{base.icon}}"><a href="{{ base.pageUrl }}" class="tsd-kind-icon">{{base.name}}</a></li>
501
+ {% elif implementedType.name %}
502
+ <li class="code-face">{{base.name}}</li>
503
+ {% endif %}
504
+ {% endif %}
505
+ {% endfor %}
506
+ </ul>
507
+ {% endif %}
508
+
509
+ {% if extendedTypes %}
510
+ <h2>Extends</h2>
511
+ <ul class="list-plain trailer-1">
512
+ {% for extendedType in extendedTypes %}
513
+ {% if extendedType.id %}
514
+ {% set base = API_TOOLS.findById(data.typedoc, extendedType.id) %}
515
+ <li class="code-face {{base.icon}}"><a href="{{ base.pageUrl }}" class="tsd-kind-icon">{{base.name}}</a></li>
516
+ {% elif extendedType.name %}
517
+ {% set base = API_TOOLS.findByName(data.typedoc, extendedType.name) %}
518
+ {% if base %}
519
+ <li class="code-face {{base.icon}}"><a href="{{ base.pageUrl }}" class="tsd-kind-icon">{{base.name}}</a></li>
520
+ {% elif extendedType.name %}
521
+ <li class="code-face">{{base.name}}</li>
522
+ {% endif %}
523
+ {% endif %}
524
+ {% endfor %}
525
+ </ul>
526
+ {% endif %}
527
+
528
+ {% if type %}
529
+ Value(s):
530
+ <pre style="display: inline;">{{@type(type)}}</pre>
531
+ {% endif %}
532
+
533
+ {% if groups %}
534
+ {% for group in groups %}
535
+ <h2 class="font-size-3">{{group.title}}</h2>
536
+
537
+ {% if group.title == 'Enumeration members' %}
538
+ {{ @properties(group, children) }}
539
+ {% endif %}
540
+
541
+ {% if group.title == 'Properties' %}
542
+ {{ @properties(group, children) }}
543
+ {% endif %}
544
+
545
+ {% if group.title == 'Constructors' %}
546
+ {% set firstSignature = API_TOOLS.findChildById(group.children[0], children).signatures[0] %}
547
+ <div class="fonts-size--1 panel padding-leader-half padding-trailer-half padding-right-half padding-left-half trailer-half">
548
+ <ul class="list-plain trailer-0 {{ API_TOOLS.findChildById(group.children[0], children).icon }}">
549
+ {% for id in group.children %}
550
+ {% set signatures = API_TOOLS.findChildById(id, children).signatures %}
551
+ {% for signature in signatures %}
552
+ {{ @signature(signature) }}
553
+ {% endfor %}
554
+ {% endfor %}
555
+ </ul>
556
+ </div>
557
+
558
+ <h2 class="font-size-1">Constructor Parameters</h2>
559
+ {{@parametersTable(firstSignature.parameters, 'Constructor')}}
560
+ {% endif %}
561
+
562
+ {% if group.title == 'Accessors' %}
563
+ {{ @accessorsTable(group, children) }}
564
+ {% endif %}
565
+
566
+ {% if group.title == 'Methods' %}
567
+ {{ @methodsTable(group, children) }}
568
+ {% endif %}
569
+
570
+ {% endfor %}
571
+ {% endif %}
572
+
573
+ {% if indexSignature %}
574
+ <h3>Index Signatures</h3>
575
+ {{@indexSignature(indexSignature, kindString)}}
576
+ {% endif %}
577
+
578
+ {% if signatures %}
579
+ {{@signatures(signatures)}}
580
+ {% endif %}
581
+
582
+ <hr class="leader-half trailer-half">
583
+
584
+ {% if signatures[0].comment.tags %}
585
+ {% for tag in signatures[0].comment.tags %}
586
+ {% if tag.tag === "restlink" %}
587
+ <small class="font-size--2">REST API documentation for <code>{{name}}()</code> available at <a href="{{tag.text}}">{{tag.text}}</a></small>
588
+ <br>
589
+ {% endif %}
590
+ {% endfor %}
591
+ {% endif %}
592
+
593
+ <small class="font-size--2">{{kindString}} defined in <a href="https://github.com/Esri/arcgis-rest-js/blob/master/packages/{{sources[0].fileName}}#L{{sources[0].line}}">packages/{{sources[0].fileName}}:{{sources[0].line}}</a></small>
594
+
595
+ {% if isDev %}
596
+ <details class="leader-1">
597
+ <summary>Debug Info</summary>
598
+ <pre><code>{{signatures[0].comment.tags | inspect}}</code></pre>
599
+ </details>
600
+ {% endif %}