@metamask/open-rpc-docs-react - npm Package Compare versions

Comparing version 0.0.3 to 0.1.0

CHANGELOG.md

@@ -9,2 +9,9 @@ # Changelog
 
+## [0.1.0]
+### Uncategorized
+- Fixed alignemnt of interactive method ([#15](https://github.com/MetaMask/open-rpc-docs-react/pull/15))
+- Fixed linking issues ([#14](https://github.com/MetaMask/open-rpc-docs-react/pull/14))
+- Removed inline on h1 tag in Method ([#13](https://github.com/MetaMask/open-rpc-docs-react/pull/13))
+- Fixed repo urls ([#12](https://github.com/MetaMask/open-rpc-docs-react/pull/12))
+
 ## [0.0.3]
@@ -298,5 +305,6 @@ ### Uncategorized
 
-[Unreleased]: https://github.com/MetaMask/openrpc-docs-react/compare/v0.0.3...HEAD
-[0.0.3]: https://github.com/MetaMask/openrpc-docs-react/compare/v0.0.2...v0.0.3
-[0.0.2]: https://github.com/MetaMask/openrpc-docs-react/compare/v0.0.1...v0.0.2
-[0.0.1]: https://github.com/MetaMask/openrpc-docs-react/releases/tag/v0.0.1
+[Unreleased]: https://github.com/MetaMask/open-rpc-docs-react/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/MetaMask/open-rpc-docs-react/compare/v0.0.3...v0.1.0
+[0.0.3]: https://github.com/MetaMask/open-rpc-docs-react/compare/v0.0.2...v0.0.3
+[0.0.2]: https://github.com/MetaMask/open-rpc-docs-react/compare/v0.0.1...v0.0.2
+[0.0.1]: https://github.com/MetaMask/open-rpc-docs-react/releases/tag/v0.0.1

dist/ArrayFieldItemTemplate/ArrayFieldItemTemplate.js

@@ -22,13 +22,13 @@ "use strict";
         react_1.default.createElement("div", { className: hasToolbar ? 'col col--9' : 'col col--12' }, children),
-        hasToolbar && (react_1.default.createElement("div", { className: 'col col--3 array-item-toolbox' },
-            react_1.default.createElement("div", { className: 'btn-group', style: {
-                    display: 'flex',
-                    justifyContent: 'space-around',
-                } },
-                (hasMoveUp || hasMoveDown) && (react_1.default.createElement(MoveUpButton, { style: btnStyle, disabled: disabled || readonly || !hasMoveUp, onClick: onReorderClick(index, index - 1), uiSchema: uiSchema, registry: registry })),
-                (hasMoveUp || hasMoveDown) && (react_1.default.createElement(MoveDownButton, { style: btnStyle, disabled: disabled || readonly || !hasMoveDown, onClick: onReorderClick(index, index + 1), uiSchema: uiSchema, registry: registry })),
-                hasCopy && (react_1.default.createElement(CopyButton, { style: btnStyle, disabled: disabled || readonly, onClick: onCopyIndexClick(index), uiSchema: uiSchema, registry: registry })),
-                hasRemove && (react_1.default.createElement(RemoveButton, { style: btnStyle, disabled: disabled || readonly, onClick: onDropIndexClick(index), uiSchema: uiSchema, registry: registry })))))));
+        hasToolbar && (react_1.default.createElement("div", { className: 'col col--3 array-item-toolbox', style: {
+                display: 'flex',
+                justifyContent: 'center',
+                alignItems: 'center',
+            } },
+            (hasMoveDown || hasMoveUp) && (react_1.default.createElement(MoveUpButton, { style: btnStyle, disabled: disabled || readonly || !hasMoveUp, onClick: onReorderClick(index, index - 1), uiSchema: uiSchema, registry: registry })),
+            (hasMoveUp || hasMoveDown) && (react_1.default.createElement(MoveDownButton, { style: btnStyle, disabled: disabled || readonly || !hasMoveDown, onClick: onReorderClick(index, index + 1), uiSchema: uiSchema, registry: registry })),
+            hasCopy && (react_1.default.createElement(CopyButton, { style: btnStyle, disabled: disabled || readonly, onClick: onCopyIndexClick(index), uiSchema: uiSchema, registry: registry })),
+            hasRemove && (react_1.default.createElement(RemoveButton, { style: btnStyle, disabled: disabled || readonly, onClick: onDropIndexClick(index), uiSchema: uiSchema, registry: registry }))))));
 }
 exports.default = ArrayFieldItemTemplate;
 //# sourceMappingURL=ArrayFieldItemTemplate.js.map

dist/ArrayFieldTemplate/ArrayFieldTemplate.js

@@ -23,6 +23,8 @@ "use strict";
             react_1.default.createElement(ArrayFieldTitleTemplate, { idSchema: idSchema, title: uiOptions.title || title, required: required, schema: schema, uiSchema: uiSchema, registry: registry }),
-            react_1.default.createElement("div", { className: 'col col--12 array-item-list' },
-                react_1.default.createElement("div", { className: 'container' }, items &&
-                    items.map(({ key, ...itemProps }) => (react_1.default.createElement(ArrayFieldItemTemplate, { key: key, ...itemProps }))))),
-            canAdd && (react_1.default.createElement("div", { className: "col col--12" },
+            react_1.default.createElement("div", { className: 'array-item-list' }, items &&
+                items.map(({ key, ...itemProps }) => (react_1.default.createElement(ArrayFieldItemTemplate, { key: key, ...itemProps })))),
+            canAdd && (react_1.default.createElement("div", { className: "col col--12", style: {
+                    justifyContent: 'end',
+                    display: 'flex'
+                } },
                 react_1.default.createElement(AddButton, { className: 'array-item-add', onClick: onAddClick, disabled: disabled || readonly, uiSchema: uiSchema, registry: registry }))))));
@@ -29,0 +31,0 @@ }

dist/FieldErrorTemplate/FieldErrorTemplate.js

@@ -17,3 +17,3 @@ "use strict";
     const id = (0, utils_1.errorId)(idSchema);
-    return (react_1.default.createElement("div", null, errors
+    return (react_1.default.createElement("div", { className: "col col--12" }, errors
         .filter((elem) => !!elem)
@@ -20,0 +20,0 @@ .map((error, index) => {

dist/FieldTemplate/Label.js

@@ -17,3 +17,6 @@ "use strict";
     }
-    return (react_1.default.createElement("label", { className: 'control-label col col--2', htmlFor: id },
+    if (/-\d+/.test(label) && id && /_\d+/.test(id)) {
+        return null;
+    }
+    return (react_1.default.createElement("label", { className: 'control-label', htmlFor: id },
         label,
@@ -20,0 +23,0 @@ required && react_1.default.createElement("span", { className: 'required' },

dist/InteractiveMethod/InteractiveMethod.js

@@ -37,2 +37,3 @@ "use strict";
 const FieldTemplate_1 = __importDefault(require("../FieldTemplate/FieldTemplate"));
+const ObjectFieldTemplate_1 = __importDefault(require("../ObjectFieldTemplate/ObjectFieldTemplate"));
 const qs = require('qs');
@@ -47,40 +48,33 @@ const { useHistory, useLocation } = require('@docusaurus/router');
 };
-/* function ArrayFieldTemplate(props: ArrayFieldTemplateProps) {
- *   console.log(props);
- *   const ArrayFieldItemTemplateFromProps
- *   return (
- *     <div className="container">
- *       <div className="row">
- *         {props.title && <b className="col col--9">{props.title}</b>}
- *         {
- *           props.canAdd &&
- *           <div className="col col--3">
- *             <button className="button button--block button--outline button--primary" type='button' onClick={props.onAddClick}>+</button>
- *           </div>
- *         }
- *       </div>
- *
- *       <div className="row">
- *         <div className="col col--12">
- *           {props.items.map((element) => element.children)}
- *         </div>
- *       </div>
- *     </div>
- *   );
- * } */
 function AddButton(props) {
     const { icon, iconType, ...btnProps } = props;
-    return (react_1.default.createElement("button", { ...btnProps, className: btnProps.className + " button button--outline button--primary", type: 'button' }, "+"));
+    return (react_1.default.createElement("button", { ...btnProps, className: btnProps.className + " button button--primary", type: 'button' }, "+"));
 }
 function RemoveButton(props) {
     const { icon, iconType, ...btnProps } = props;
-    return (react_1.default.createElement("button", { ...btnProps, className: "button button--outline button--primary", type: 'button' }, "-"));
+    const style = {
+        ...btnProps.style,
+        minWidth: '35px',
+        maxWidth: '36px',
+        border: undefined
+    };
+    return (react_1.default.createElement("button", { ...btnProps, style: style, className: "button button--outline button--primary", type: 'button' }, "-"));
 }
 function MoveUpButton(props) {
     const { icon, iconType, ...btnProps } = props;
-    return (react_1.default.createElement("button", { ...btnProps, className: "button button--outline button--primary", type: 'button' }, "\u25B2"));
+    const style = {
+        ...btnProps.style,
+        minWidth: '35px',
+        maxWidth: '36px',
+    };
+    return (react_1.default.createElement("button", { ...btnProps, style: style, className: "button button--outline button--primary", type: 'button' }, "\u25B2"));
 }
 function MoveDownButton(props) {
     const { icon, iconType, ...btnProps } = props;
-    return (react_1.default.createElement("button", { ...btnProps, className: "button button--outline button--primary", type: 'button' }, "\u25BC"));
+    const style = {
+        ...btnProps.style,
+        minWidth: '35px',
+        maxWidth: '36px',
+    };
+    return (react_1.default.createElement("button", { ...btnProps, style: style, className: "button button--outline button--primary", type: 'button' }, "\u25BC"));
 }
@@ -98,3 +92,10 @@ const InteractiveMethodParam = (props) => {
     schema.title = undefined;
-    return (react_1.default.createElement(core_1.default, { schema: schema, formData: props.formData, showErrorList: false, uiSchema: uiSchema, validator: validator_ajv8_1.default, ref: refref, templates: { ArrayFieldItemTemplate: ArrayFieldItemTemplate_1.default, ArrayFieldTemplate: ArrayFieldTemplate_1.default, FieldErrorTemplate: FieldErrorTemplate_1.default, FieldTemplate: FieldTemplate_1.default, ButtonTemplates: { AddButton, RemoveButton, MoveUpButton, MoveDownButton } }, onChange: props.onChange, onError: log('errors'), liveValidate: true }));
+    return (react_1.default.createElement(core_1.default, { schema: schema, formData: props.formData, showErrorList: false, uiSchema: uiSchema, validator: validator_ajv8_1.default, ref: refref, templates: {
+            ArrayFieldItemTemplate: ArrayFieldItemTemplate_1.default,
+            ArrayFieldTemplate: ArrayFieldTemplate_1.default,
+            FieldErrorTemplate: FieldErrorTemplate_1.default,
+            FieldTemplate: FieldTemplate_1.default,
+            ButtonTemplates: { AddButton, RemoveButton, MoveUpButton, MoveDownButton },
+            ObjectFieldTemplate: ObjectFieldTemplate_1.default
+        }, onChange: props.onChange, onError: log('errors'), liveValidate: true }));
 };
@@ -174,24 +175,26 @@ const InteractiveMethod = (props) => {
     const jsCode = `await window.ethereum.request(${JSON.stringify(methodCall, null, "  ")});`;
-    return (react_1.default.createElement(react_1.default.Fragment, null,
+    return (react_1.default.createElement("div", { className: "container" },
         method.params.length > 0 &&
             react_1.default.createElement(react_1.default.Fragment, null,
-                react_1.default.createElement("div", null,
+                react_1.default.createElement("div", { className: "row" },
                     react_1.default.createElement("h3", null, "Params"),
-                    method.params.map((p, i) => (react_1.default.createElement(react_1.default.Fragment, null,
+                    react_1.default.createElement("div", { className: "col col--12" }, method.params.map((p, i) => (react_1.default.createElement(react_1.default.Fragment, null,
                         react_1.default.createElement("h4", null, p.name),
-                        react_1.default.createElement(InteractiveMethodParam, { refref: formRefs[i], formData: requestParams[p.name], onChange: (change) => handleChange(change, i), param: p }))))),
+                        react_1.default.createElement(InteractiveMethodParam, { refref: formRefs[i], formData: requestParams[p.name], onChange: (change) => handleChange(change, i), param: p })))))),
                 react_1.default.createElement("br", null)),
-        react_1.default.createElement("div", null,
+        react_1.default.createElement("div", { className: "row" },
             react_1.default.createElement("h3", null, "Request"),
-            components && components.CodeBlock && react_1.default.createElement(components.CodeBlock, { className: "language-js" }, jsCode),
-            !components?.CodeBlock &&
-                react_1.default.createElement("pre", null,
-                    react_1.default.createElement("code", null, jsCode))),
-        executionResult !== undefined && react_1.default.createElement("div", null,
+            react_1.default.createElement("div", { className: "col col--12" },
+                components && components.CodeBlock && react_1.default.createElement(components.CodeBlock, { className: "language-js" }, jsCode),
+                !components?.CodeBlock &&
+                    react_1.default.createElement("pre", null,
+                        react_1.default.createElement("code", null, jsCode)))),
+        executionResult !== undefined && react_1.default.createElement("div", { className: "row" },
             react_1.default.createElement("h3", null, "Response"),
-            components && components.CodeBlock && react_1.default.createElement(components.CodeBlock, { className: "language-json" }, JSON.stringify(executionResult, null, '  ')),
-            !components?.CodeBlock &&
-                react_1.default.createElement("pre", null,
-                    react_1.default.createElement("code", null, JSON.stringify(executionResult, null, '  ')))),
-        react_1.default.createElement("div", null,
+            react_1.default.createElement("div", { className: "col col--12" },
+                components && components.CodeBlock && react_1.default.createElement(components.CodeBlock, { className: "language-json" }, JSON.stringify(executionResult, null, '  ')),
+                !components?.CodeBlock &&
+                    react_1.default.createElement("pre", null,
+                        react_1.default.createElement("code", null, JSON.stringify(executionResult, null, '  '))))),
+        react_1.default.createElement("div", { className: "row" },
             react_1.default.createElement("button", { className: "button button--primary button--block", onClick: handleExec }, "Send Request"))));
@@ -198,0 +201,0 @@ };

dist/Method/Method.js

@@ -33,3 +33,3 @@ "use strict";
     return (react_1.default.createElement("div", { id: method.name, key: key, className: "method margin-bottom--sm" },
-        react_1.default.createElement("h1", { key: method.name, className: "method-name", style: { display: "inline", marginRight: "3px" } }, method.name),
+        react_1.default.createElement("h1", { key: method.name, className: "method-name", style: { marginRight: "3px" } }, method.name),
         method.tags && method.tags.length > 0 && react_1.default.createElement("section", { key: "tags" },
@@ -36,0 +36,0 @@ react_1.default.createElement(Tags_1.default, { tags: method.tags })),

package.json

 {
   "name": "@metamask/open-rpc-docs-react",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "description": "OpenRPC Docs React",
-  "homepage": "https://github.com/MetaMask/openrpc-docs-react#readme",
+  "homepage": "https://github.com/MetaMask/open-rpc-docs-react#readme",
   "bugs": {
-    "url": "https://github.com/MetaMask/openrpc-docs-react/issues"
+    "url": "https://github.com/MetaMask/open-rpc-docs-react/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/MetaMask/openrpc-docs-react.git"
+    "url": "https://github.com/MetaMask/open-rpc-docs-react.git"
   },
@@ -23,2 +23,3 @@ "license": "Apache-2.0",
     "build:docs": "typedoc",
+    "link:setup": "rm -rf ./node_modules/react ./node_modules/react-dom",
     "lint": "yarn lint:eslint && yarn lint:constraints && yarn lint:misc --check && yarn lint:dependencies --check && yarn lint:changelog",
@@ -25,0 +26,0 @@ "lint:changelog": "auto-changelog validate",

README.md

@@ -28,1 +28,7 @@ # @metamask/open-rpc-docs-react
 ```
+
+## Development
+
+### Linking
+
+When linking this project with others, use `yarn link:setup` to avoid getting errors about hooks / multiple react versions.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

149683

increased by5.42%

Number of package files

61

increased by5.17%

Lines of code

1190

increased by2.32%

Number of lines in readme file

34

increased by21.43%

No dependency changes