@looker/api-explorer 0.9.26 → 0.9.27

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 (214) hide show
  1. package/CHANGELOG.md +47 -1
  2. package/e2e/e2e.spec.ts +1 -1
  3. package/lib/ApiExplorer.d.ts +2 -6
  4. package/lib/ApiExplorer.js +53 -74
  5. package/lib/ApiExplorer.js.map +1 -1
  6. package/lib/StandaloneApiExplorer.js +35 -47
  7. package/lib/StandaloneApiExplorer.js.map +1 -1
  8. package/lib/components/Banner/Banner.d.ts +8 -0
  9. package/lib/components/Banner/Banner.js +70 -0
  10. package/lib/components/Banner/Banner.js.map +1 -0
  11. package/lib/components/Banner/index.d.ts +1 -0
  12. package/lib/components/Banner/index.js +14 -0
  13. package/lib/components/Banner/index.js.map +1 -0
  14. package/lib/components/DocSDKs/DocSDKs.js +3 -3
  15. package/lib/components/DocSDKs/DocSDKs.js.map +1 -1
  16. package/lib/components/ExploreType/ExploreType.js +3 -5
  17. package/lib/components/ExploreType/ExploreType.js.map +1 -1
  18. package/lib/components/Header/Header.d.ts +2 -5
  19. package/lib/components/Header/Header.js +1 -5
  20. package/lib/components/Header/Header.js.map +1 -1
  21. package/lib/components/SelectorContainer/ApiSpecSelector.d.ts +2 -5
  22. package/lib/components/SelectorContainer/ApiSpecSelector.js +5 -5
  23. package/lib/components/SelectorContainer/ApiSpecSelector.js.map +1 -1
  24. package/lib/components/SelectorContainer/SelectorContainer.d.ts +2 -5
  25. package/lib/components/SelectorContainer/SelectorContainer.js +3 -7
  26. package/lib/components/SelectorContainer/SelectorContainer.js.map +1 -1
  27. package/lib/components/SideNav/SideNav.d.ts +2 -5
  28. package/lib/components/SideNav/SideNav.js.map +1 -1
  29. package/lib/components/index.d.ts +1 -0
  30. package/lib/components/index.js +8 -0
  31. package/lib/components/index.js.map +1 -1
  32. package/lib/esm/ApiExplorer.js +54 -74
  33. package/lib/esm/ApiExplorer.js.map +1 -1
  34. package/lib/esm/StandaloneApiExplorer.js +34 -48
  35. package/lib/esm/StandaloneApiExplorer.js.map +1 -1
  36. package/lib/esm/components/Banner/Banner.js +54 -0
  37. package/lib/esm/components/Banner/Banner.js.map +1 -0
  38. package/lib/esm/components/Banner/index.js +2 -0
  39. package/lib/esm/components/Banner/index.js.map +1 -0
  40. package/lib/esm/components/DocSDKs/DocSDKs.js +2 -2
  41. package/lib/esm/components/DocSDKs/DocSDKs.js.map +1 -1
  42. package/lib/esm/components/ExploreType/ExploreType.js +3 -4
  43. package/lib/esm/components/ExploreType/ExploreType.js.map +1 -1
  44. package/lib/esm/components/Header/Header.js +1 -5
  45. package/lib/esm/components/Header/Header.js.map +1 -1
  46. package/lib/esm/components/SelectorContainer/ApiSpecSelector.js +4 -5
  47. package/lib/esm/components/SelectorContainer/ApiSpecSelector.js.map +1 -1
  48. package/lib/esm/components/SelectorContainer/SelectorContainer.js +3 -7
  49. package/lib/esm/components/SelectorContainer/SelectorContainer.js.map +1 -1
  50. package/lib/esm/components/SideNav/SideNav.js.map +1 -1
  51. package/lib/esm/components/index.js +1 -0
  52. package/lib/esm/components/index.js.map +1 -1
  53. package/lib/esm/index.js +1 -0
  54. package/lib/esm/index.js.map +1 -1
  55. package/lib/esm/routes/AppRouter.js +3 -7
  56. package/lib/esm/routes/AppRouter.js.map +1 -1
  57. package/lib/esm/scenes/DiffScene/DiffScene.js +43 -99
  58. package/lib/esm/scenes/DiffScene/DiffScene.js.map +1 -1
  59. package/lib/esm/scenes/DiffScene/DocDiff/DiffItem.js +9 -13
  60. package/lib/esm/scenes/DiffScene/DocDiff/DiffItem.js.map +1 -1
  61. package/lib/esm/scenes/DiffScene/DocDiff/DocDiff.js +2 -2
  62. package/lib/esm/scenes/DiffScene/DocDiff/DocDiff.js.map +1 -1
  63. package/lib/esm/scenes/MethodScene/MethodScene.js +4 -5
  64. package/lib/esm/scenes/MethodScene/MethodScene.js.map +1 -1
  65. package/lib/esm/state/index.js +1 -0
  66. package/lib/esm/state/index.js.map +1 -1
  67. package/lib/esm/state/specs/index.js +3 -0
  68. package/lib/esm/state/specs/index.js.map +1 -0
  69. package/lib/esm/state/specs/sagas.js +58 -0
  70. package/lib/esm/state/specs/sagas.js.map +1 -0
  71. package/lib/esm/state/specs/selectors.js +8 -0
  72. package/lib/esm/state/specs/selectors.js.map +1 -0
  73. package/lib/esm/state/specs/slice.js +55 -0
  74. package/lib/esm/state/specs/slice.js.map +1 -0
  75. package/lib/esm/state/store.js +53 -2
  76. package/lib/esm/state/store.js.map +1 -1
  77. package/lib/esm/test-utils/redux.js +9 -5
  78. package/lib/esm/test-utils/redux.js.map +1 -1
  79. package/lib/esm/utils/adaptorUtils.js +101 -0
  80. package/lib/esm/utils/adaptorUtils.js.map +1 -0
  81. package/lib/esm/utils/apixAdaptor.js +48 -0
  82. package/lib/esm/utils/apixAdaptor.js.map +1 -0
  83. package/lib/esm/utils/index.js +3 -1
  84. package/lib/esm/utils/index.js.map +1 -1
  85. package/lib/esm/utils/path.js +27 -2
  86. package/lib/esm/utils/path.js.map +1 -1
  87. package/lib/index.d.ts +1 -0
  88. package/lib/index.js +13 -0
  89. package/lib/index.js.map +1 -1
  90. package/lib/routes/AppRouter.d.ts +1 -5
  91. package/lib/routes/AppRouter.js +3 -7
  92. package/lib/routes/AppRouter.js.map +1 -1
  93. package/lib/scenes/DiffScene/DiffScene.js +45 -100
  94. package/lib/scenes/DiffScene/DiffScene.js.map +1 -1
  95. package/lib/scenes/DiffScene/DocDiff/DiffItem.js +9 -13
  96. package/lib/scenes/DiffScene/DocDiff/DiffItem.js.map +1 -1
  97. package/lib/scenes/DiffScene/DocDiff/DocDiff.js +2 -2
  98. package/lib/scenes/DiffScene/DocDiff/DocDiff.js.map +1 -1
  99. package/lib/scenes/MethodScene/MethodScene.d.ts +0 -4
  100. package/lib/scenes/MethodScene/MethodScene.js +5 -5
  101. package/lib/scenes/MethodScene/MethodScene.js.map +1 -1
  102. package/lib/state/index.d.ts +1 -0
  103. package/lib/state/index.js +13 -0
  104. package/lib/state/index.js.map +1 -1
  105. package/lib/state/settings/selectors.d.ts +1 -1
  106. package/lib/state/settings/slice.d.ts +1 -1
  107. package/lib/state/specs/index.d.ts +2 -0
  108. package/lib/state/specs/index.js +32 -0
  109. package/lib/state/specs/index.js.map +1 -0
  110. package/lib/state/specs/sagas.d.ts +1 -0
  111. package/lib/state/specs/sagas.js +67 -0
  112. package/lib/state/specs/sagas.js.map +1 -0
  113. package/lib/state/specs/selectors.d.ts +4 -0
  114. package/lib/state/specs/selectors.js +20 -0
  115. package/lib/state/specs/selectors.js.map +1 -0
  116. package/lib/state/specs/slice.d.ts +49 -0
  117. package/lib/state/specs/slice.js +70 -0
  118. package/lib/state/specs/slice.js.map +1 -0
  119. package/lib/state/store.d.ts +3 -0
  120. package/lib/state/store.js +56 -2
  121. package/lib/state/store.js.map +1 -1
  122. package/lib/test-data/declarations.d.ts +2 -0
  123. package/lib/test-data/examples.d.ts +2 -0
  124. package/lib/test-data/index.d.ts +3 -0
  125. package/lib/test-data/index.js +12 -42
  126. package/lib/test-data/index.js.map +1 -1
  127. package/lib/test-data/specs.d.ts +10 -0
  128. package/lib/test-data/specs.js +6 -6
  129. package/lib/test-data/specs.js.map +1 -1
  130. package/lib/test-utils/redux.d.ts +2 -1
  131. package/lib/test-utils/redux.js +9 -4
  132. package/lib/test-utils/redux.js.map +1 -1
  133. package/lib/utils/adaptorUtils.d.ts +30 -0
  134. package/lib/utils/adaptorUtils.js +124 -0
  135. package/lib/utils/adaptorUtils.js.map +1 -0
  136. package/lib/utils/apixAdaptor.d.ts +15 -0
  137. package/lib/utils/apixAdaptor.js +67 -0
  138. package/lib/utils/apixAdaptor.js.map +1 -0
  139. package/lib/utils/index.d.ts +3 -1
  140. package/lib/utils/index.js +45 -30
  141. package/lib/utils/index.js.map +1 -1
  142. package/lib/utils/path.d.ts +3 -0
  143. package/lib/utils/path.js +32 -2
  144. package/lib/utils/path.js.map +1 -1
  145. package/package.json +10 -10
  146. package/src/ApiExplorer.tsx +47 -74
  147. package/src/StandaloneApiExplorer.tsx +37 -52
  148. package/src/components/Banner/Banner.spec.tsx +99 -0
  149. package/src/components/Banner/Banner.tsx +87 -0
  150. package/src/{reducers → components/Banner}/index.ts +1 -1
  151. package/src/components/DocSDKs/DocSDKs.tsx +4 -5
  152. package/src/components/ExploreType/ExploreType.spec.tsx +0 -23
  153. package/src/components/ExploreType/ExploreType.tsx +5 -6
  154. package/src/components/ExploreType/exploreUtils.spec.tsx +1 -1
  155. package/src/components/Header/Header.spec.tsx +9 -30
  156. package/src/components/Header/Header.tsx +3 -10
  157. package/src/components/SelectorContainer/ApiSpecSelector.spec.tsx +31 -44
  158. package/src/components/SelectorContainer/ApiSpecSelector.tsx +6 -12
  159. package/src/components/SelectorContainer/SelectorContainer.spec.tsx +7 -26
  160. package/src/components/SelectorContainer/SelectorContainer.tsx +4 -10
  161. package/src/components/SideNav/SideNav.spec.tsx +12 -45
  162. package/src/components/SideNav/SideNav.tsx +1 -7
  163. package/src/components/index.ts +1 -0
  164. package/src/index.ts +1 -0
  165. package/src/routes/AppRouter.tsx +25 -37
  166. package/src/scenes/DiffScene/DiffScene.tsx +47 -84
  167. package/src/scenes/DiffScene/DocDiff/DiffItem.spec.tsx +9 -16
  168. package/src/scenes/DiffScene/DocDiff/DiffItem.tsx +11 -12
  169. package/src/scenes/DiffScene/DocDiff/DocDiff.tsx +2 -2
  170. package/src/scenes/MethodScene/MethodScene.tsx +4 -10
  171. package/src/state/index.ts +1 -0
  172. package/src/{reducers/spec → state/specs}/index.ts +2 -3
  173. package/src/state/specs/sagas.spec.ts +135 -0
  174. package/src/state/specs/sagas.ts +81 -0
  175. package/src/{reducers/spec/actions.spec.ts → state/specs/selectors.ts} +12 -11
  176. package/src/state/specs/slice.ts +109 -0
  177. package/src/state/store.ts +58 -0
  178. package/src/test-data/index.ts +1 -8
  179. package/src/test-data/specs.ts +6 -6
  180. package/src/test-utils/redux.tsx +15 -4
  181. package/src/utils/adaptorUtils.ts +181 -0
  182. package/src/utils/apixAdaptor.ts +72 -0
  183. package/src/utils/index.ts +3 -7
  184. package/src/utils/path.ts +25 -2
  185. package/lib/esm/reducers/index.js +0 -2
  186. package/lib/esm/reducers/index.js.map +0 -1
  187. package/lib/esm/reducers/spec/actions.js +0 -19
  188. package/lib/esm/reducers/spec/actions.js.map +0 -1
  189. package/lib/esm/reducers/spec/index.js +0 -4
  190. package/lib/esm/reducers/spec/index.js.map +0 -1
  191. package/lib/esm/reducers/spec/reducer.js +0 -62
  192. package/lib/esm/reducers/spec/reducer.js.map +0 -1
  193. package/lib/esm/reducers/spec/utils.js +0 -74
  194. package/lib/esm/reducers/spec/utils.js.map +0 -1
  195. package/lib/reducers/index.d.ts +0 -1
  196. package/lib/reducers/index.js +0 -19
  197. package/lib/reducers/index.js.map +0 -1
  198. package/lib/reducers/spec/actions.d.ts +0 -20
  199. package/lib/reducers/spec/actions.js +0 -31
  200. package/lib/reducers/spec/actions.js.map +0 -1
  201. package/lib/reducers/spec/index.d.ts +0 -3
  202. package/lib/reducers/spec/index.js +0 -45
  203. package/lib/reducers/spec/index.js.map +0 -1
  204. package/lib/reducers/spec/reducer.d.ts +0 -7
  205. package/lib/reducers/spec/reducer.js +0 -73
  206. package/lib/reducers/spec/reducer.js.map +0 -1
  207. package/lib/reducers/spec/utils.d.ts +0 -7
  208. package/lib/reducers/spec/utils.js +0 -91
  209. package/lib/reducers/spec/utils.js.map +0 -1
  210. package/src/reducers/spec/actions.ts +0 -62
  211. package/src/reducers/spec/reducer.spec.ts +0 -44
  212. package/src/reducers/spec/reducer.ts +0 -69
  213. package/src/reducers/spec/utils.spec.ts +0 -138
  214. package/src/reducers/spec/utils.ts +0 -123
@@ -1,123 +0,0 @@
1
- /*
2
-
3
- MIT License
4
-
5
- Copyright (c) 2021 Looker Data Sciences, Inc.
6
-
7
- Permission is hereby granted, free of charge, to any person obtaining a copy
8
- of this software and associated documentation files (the "Software"), to deal
9
- in the Software without restriction, including without limitation the rights
10
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11
- copies of the Software, and to permit persons to whom the Software is
12
- furnished to do so, subject to the following conditions:
13
-
14
- The above copyright notice and this permission notice shall be included in all
15
- copies or substantial portions of the Software.
16
-
17
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23
- SOFTWARE.
24
-
25
- */
26
-
27
- import type { SpecList } from '@looker/sdk-codegen'
28
- import type { Location as HLocation } from 'history'
29
- import { OAuthSession } from '@looker/sdk-rtl'
30
- import { diffPath, oAuthPath } from '../../utils'
31
- import type { SpecState } from './reducer'
32
-
33
- export type AbstractLocation = HLocation | Location
34
-
35
- /**
36
- * Given a collection of specs, it returns the spec marked as default, the one
37
- * marked as current or the first one, in that order.
38
- * @param specs A collection of specs
39
- * @returns A spec
40
- */
41
- export const getDefaultSpecKey = (specs: SpecList): string => {
42
- const items = Object.entries(specs)
43
-
44
- if (items.length === 0) {
45
- throw Error('No specs found.')
46
- }
47
-
48
- let specKey = ''
49
- items.forEach(([key, item]) => {
50
- if (item.isDefault) {
51
- specKey = key
52
- }
53
- })
54
-
55
- if (!specKey) {
56
- items.forEach(([key, item]) => {
57
- if (item.status === 'current') {
58
- specKey = key
59
- }
60
- })
61
- }
62
-
63
- if (!specKey) {
64
- specKey = Object.keys(specs)[0]
65
- }
66
-
67
- if (!specKey) {
68
- throw Error('No specs found.')
69
- }
70
-
71
- return specKey
72
- }
73
-
74
- /**
75
- * Determine the API specification key from URL pattern or default spec
76
- * @param location service to examine
77
- * @param specs to use to find the default spec key
78
- */
79
- export const getSpecKey = (location: AbstractLocation, specs?: SpecList) => {
80
- let pathName = location.pathname
81
- if (pathName === `/${oAuthPath}`) {
82
- const returnUrl = sessionStorage.getItem(OAuthSession.returnUrlKey)
83
- if (returnUrl) {
84
- pathName = returnUrl
85
- }
86
- }
87
- const pathNodes = pathName.split('/')
88
- let specKey = ''
89
- if (
90
- pathNodes.length > 1 &&
91
- pathNodes[1] &&
92
- pathNodes[1] !== oAuthPath &&
93
- pathNodes[1] !== diffPath
94
- ) {
95
- specKey = pathNodes[1]
96
- } else if (specs) {
97
- specKey = getDefaultSpecKey(specs)
98
- }
99
- return specKey
100
- }
101
-
102
- /**
103
- * Creates a default state object with the spec matching the specKey defined
104
- * in the url or the default criteria in getDefaultSpecKey
105
- * @param specList A collection of specs
106
- * @param location Standalone or extension location
107
- * @returns An object to be used as default state
108
- */
109
- export const initDefaultSpecState = (
110
- specList: SpecList,
111
- location: AbstractLocation
112
- ): SpecState => {
113
- const specKey = getSpecKey(location, specList)
114
- // Handle bad spec in the URL. Fall back to 4.0
115
- let spec = specList[specKey]
116
- if (!spec) {
117
- spec = specList['4.0']
118
- }
119
- return {
120
- specList,
121
- spec,
122
- }
123
- }