@jpmorganchase/elemental 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (35) hide show
  1. package/.storybook/main.js +1 -0
  2. package/.storybook/manager.js +1 -0
  3. package/.storybook/preview.jsx +3 -0
  4. package/LICENSE +190 -0
  5. package/README.md +19 -0
  6. package/jest.config.js +7 -0
  7. package/package.json +111 -0
  8. package/src/__fixtures__/api-descriptions/Instagram.ts +1859 -0
  9. package/src/__fixtures__/api-descriptions/badgesForSchema.ts +36 -0
  10. package/src/__fixtures__/api-descriptions/simpleApiWithInternalOperations.ts +253 -0
  11. package/src/__fixtures__/api-descriptions/simpleApiWithoutDescription.ts +243 -0
  12. package/src/__fixtures__/api-descriptions/todosApiBundled.ts +430 -0
  13. package/src/__fixtures__/api-descriptions/zoomApiYaml.ts +6083 -0
  14. package/src/components/API/APIWithSidebarLayout.tsx +111 -0
  15. package/src/components/API/APIWithStackedLayout.tsx +220 -0
  16. package/src/components/API/__tests__/utils.test.ts +848 -0
  17. package/src/components/API/utils.ts +174 -0
  18. package/src/containers/API.spec.tsx +131 -0
  19. package/src/containers/API.stories.tsx +99 -0
  20. package/src/containers/API.tsx +200 -0
  21. package/src/hooks/useExportDocumentProps.spec.tsx +68 -0
  22. package/src/hooks/useExportDocumentProps.tsx +48 -0
  23. package/src/index.ts +2 -0
  24. package/src/styles.css +1 -0
  25. package/src/utils/oas/__tests__/oas.spec.ts +272 -0
  26. package/src/utils/oas/index.ts +150 -0
  27. package/src/utils/oas/oas2.ts +31 -0
  28. package/src/utils/oas/oas3.ts +37 -0
  29. package/src/utils/oas/types.ts +31 -0
  30. package/src/web-components/__stories__/Api.stories.tsx +63 -0
  31. package/src/web-components/components.ts +20 -0
  32. package/src/web-components/index.ts +3 -0
  33. package/tsconfig.build.json +18 -0
  34. package/tsconfig.json +7 -0
  35. package/web-components.config.js +1 -0
@@ -0,0 +1 @@
1
+ module.exports = require('../../../.storybook/main.js');
@@ -0,0 +1 @@
1
+ require("../../../.storybook/manager");
@@ -0,0 +1,3 @@
1
+ export * from '../../../.storybook/preview';
2
+
3
+ import '../src/styles.css';
package/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2018 Stoplight, Inc.
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,19 @@
1
+ [![docs](https://img.shields.io/badge/API%20Docs-site-green.svg?style=flat-square)](https://meta.stoplight.io/docs/elements)
2
+ [![license](https://img.shields.io/npm/l/@stoplight/elements?style=flat-square)](./LICENSE)
3
+
4
+ # @stoplight/elements
5
+
6
+ Elements is a collection of UI components for displaying beautiful developer documentation from any OpenAPI document.
7
+ ## Documentation
8
+
9
+ Visit our **[Documentation](https://meta.stoplight.io/docs/elements)** for getting starting, guides and demos.
10
+
11
+ ## About
12
+
13
+ Elements is developed and maintained by [Stoplight](https://stoplight.io).
14
+
15
+ ## License
16
+
17
+ Licensed under the Apache 2.0 License, Copyright © 2020-present Stoplight.
18
+
19
+ See [LICENSE](LICENSE) for more information.
package/jest.config.js ADDED
@@ -0,0 +1,7 @@
1
+ module.exports = {
2
+ ...require('../../jest.config'),
3
+ reporters: [
4
+ 'default',
5
+ ['jest-junit', { suiteName: 'elements', outputFile: '<rootDir>/../../test-results/elements/results.xml' }],
6
+ ],
7
+ };
package/package.json ADDED
@@ -0,0 +1,111 @@
1
+ {
2
+ "name": "@jpmorganchase/elemental",
3
+ "version": "1.0.0",
4
+ "description": "UI components for composing beautiful developer documentation.",
5
+ "keywords": [],
6
+ "sideEffects": [
7
+ "web-components.min.js",
8
+ "src/web-components/**",
9
+ "**/*.css"
10
+ ],
11
+ "homepage": "https://github.com/jpmorganchase/elemental",
12
+ "repository": {
13
+ "type": "git",
14
+ "url": "git@github.com:jpmorganchase/elemental.git",
15
+ "directory": "packages/elements"
16
+ },
17
+ "license": "Apache-2.0",
18
+ "type": "commonjs",
19
+ "main": "./dist/index.js",
20
+ "module": "./dist/index.esm.js",
21
+ "exports": {
22
+ "./styles.min.css": "./styles.min.css",
23
+ "./web-components.min.js": "./web-components.min.js",
24
+ ".": {
25
+ "require": "./dist/index.js",
26
+ "import": "./dist/index.mjs"
27
+ }
28
+ },
29
+ "files": [
30
+ "**/*"
31
+ ],
32
+ "engines": {
33
+ "node": ">=14.13"
34
+ },
35
+ "scripts": {
36
+ "build": "concurrently \"yarn:build.react\" \"yarn:build.webcomponents\"",
37
+ "postbuild": "yarn build.styles",
38
+ "build.react": "sl-scripts bundle",
39
+ "build.styles": "postcss src/styles.css -o dist/styles.min.css",
40
+ "build.webcomponents": "webpack -c ./web-components.config.js",
41
+ "build.docs": "build-storybook -c .storybook -o dist-storybook",
42
+ "commit": "git-cz",
43
+ "release": "sl-scripts release",
44
+ "release.docs": "sl-scripts release:docs",
45
+ "release.dryRun": "sl-scripts release --dry-run --debug",
46
+ "storybook": "start-storybook -p 9001",
47
+ "test": "jest",
48
+ "test.prod": "yarn test --coverage --maxWorkers=2",
49
+ "test.update": "yarn test --updateSnapshot",
50
+ "test.watch": "yarn test --watch",
51
+ "test.packaging": "node --input-type=commonjs -e \"require('./dist/index.js')\" && node --input-type=module -e \"import './dist/index.mjs'\"",
52
+ "type-check": "tsc --noEmit"
53
+ },
54
+ "peerDependencies": {
55
+ "react": ">=16.8",
56
+ "react-dom": ">=16.8"
57
+ },
58
+ "rollup": {
59
+ "bundleDeps": [
60
+ "@fortawesome/free-solid-svg-icons"
61
+ ]
62
+ },
63
+ "dependencies": {
64
+ "@stoplight/elements-core": "~7.7.18",
65
+ "@stoplight/http-spec": "^5.1.4",
66
+ "@stoplight/json": "^3.18.1",
67
+ "@stoplight/mosaic": "^1.33.0",
68
+ "@stoplight/types": "^13.7.0",
69
+ "@stoplight/yaml": "^4.2.3",
70
+ "classnames": "^2.2.6",
71
+ "file-saver": "^2.0.5",
72
+ "lodash": "^4.17.19",
73
+ "react-query": "^3.34.19",
74
+ "react-router-dom": "^5.2.0"
75
+ },
76
+ "devDependencies": {
77
+ "@fortawesome/free-solid-svg-icons": "^6.1.1",
78
+ "@stoplight/scripts": "9.2.1",
79
+ "@testing-library/dom": "^7.26.5",
80
+ "@testing-library/jest-dom": "^5.16.4",
81
+ "@testing-library/react": "^11.1.1",
82
+ "@testing-library/react-hooks": "^3.4.2",
83
+ "@testing-library/user-event": "^12.2.0",
84
+ "@types/enzyme": "3.x.x",
85
+ "@types/enzyme-adapter-react-16": "1.x.x",
86
+ "@types/file-saver": "^2.0.5",
87
+ "@types/json-schema": "^7.0.11",
88
+ "@types/lodash": "^4.14.181",
89
+ "@types/react": "16.9.56",
90
+ "@types/react-dom": "16.9.12",
91
+ "@types/react-router-dom": "^5.3.3",
92
+ "enzyme": "3.x.x",
93
+ "enzyme-adapter-react-16": "1.x.x",
94
+ "enzyme-to-json": "3.x.x",
95
+ "jest-enzyme": "^7.1.2",
96
+ "jest-fetch-mock": "^3.0.3",
97
+ "react": "16.14.0",
98
+ "react-dom": "16.14.0",
99
+ "react-test-renderer": "^16.8.0",
100
+ "resolve-url-loader": "^3.1.2",
101
+ "style-loader": "^2.0.0",
102
+ "ts-loader": "^9.2.8"
103
+ },
104
+ "publishConfig": {
105
+ "directory": "dist",
106
+ "access": "public"
107
+ },
108
+ "release": {
109
+ "extends": "@stoplight/scripts/release"
110
+ }
111
+ }