@americanexpress/react-seo - npm Package Compare versions

Comparing version 2.3.0 to 2.4.0

build/components/SEO.js

@@ -33,3 +33,4 @@ "use strict";
 var SEO = function SEO(_ref) {
-  var siteUrl = _ref.siteUrl,
+  var children = _ref.children,
+      siteUrl = _ref.siteUrl,
       title = _ref.title,
@@ -98,35 +99,7 @@ description = _ref.description,
     meta: meta
-  }, title && /*#__PURE__*/_react.default.createElement("title", null, title));
+  }, title && /*#__PURE__*/_react.default.createElement("title", null, title), children);
 };
 
-SEO.propTypes = {
-  siteUrl: _propTypes.default.string.isRequired,
-  title: _propTypes.default.string.isRequired,
-  description: _propTypes.default.string,
-  locale: _propTypes.default.string,
-  titleTemplate: _propTypes.default.string,
-  canonical: _propTypes.default.string,
-  openGraph: _shapes.openGraphShape,
-  twitterCard: _shapes.twitterCardShape,
-  keywords: _propTypes.default.arrayOf(_propTypes.default.string),
-  robots: _propTypes.default.arrayOf(_propTypes.default.string),
-  image: _propTypes.default.shape({
-    url: _propTypes.default.string,
-    secureUrl: _propTypes.default.string,
-    width: _propTypes.default.number,
-    height: _propTypes.default.number,
-    type: _propTypes.default.string,
-    alt: _propTypes.default.string
-  }),
-  video: _propTypes.default.shape({
-    url: _propTypes.default.string,
-    secureUrl: _propTypes.default.string,
-    type: _propTypes.default.string,
-    width: _propTypes.default.number,
-    height: _propTypes.default.number,
-    alt: _propTypes.default.string
-  }),
-  alternateLinks: _propTypes.default.arrayOf(_shapes.alternateLinkShape)
-};
 SEO.defaultProps = {
+  children: null,
   description: '',
@@ -133,0 +106,0 @@ locale: 'en-US',

build/index.js

@@ -16,2 +16,3 @@ "use strict";
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _shapes[key]) return;
   Object.defineProperty(exports, key, {
@@ -18,0 +19,0 @@ enumerable: true,

CHANGELOG.md

@@ -0,1 +1,8 @@
+# [2.4.0](https://github.com/americanexpress/react-seo/compare/v2.3.0...v2.4.0) (2020-11-05)
+
+
+### Features
+
+* **proptypes:** allow children as prop ([#29](https://github.com/americanexpress/react-seo/issues/29)) ([9c7a57b](https://github.com/americanexpress/react-seo/commit/9c7a57b35f4cc85ad3c152a75db9fede171f64b3))
+
 # [2.3.0](https://github.com/americanexpress/react-seo/compare/v2.2.1...v2.3.0) (2020-10-21)
@@ -2,0 +9,0 @@

package.json

 {
   "name": "@americanexpress/react-seo",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "Simple SEO tag manager for React",
@@ -10,3 +10,3 @@ "main": "build/index.js",
     "test:lockfile": "lockfile-lint -p package-lock.json -t npm -a npm -o https: -c -i",
-    "test:git-history": "commitlint --from origin/master --to HEAD",
+    "test:git-history": "commitlint --from origin/main --to HEAD",
     "build": "babel src --out-dir build",
@@ -74,2 +74,16 @@ "clean": "rimraf build",
   "release": {
+    "branches": [
+      "+([0-9])?(.{+([0-9]),x}).x",
+      "main",
+      "next",
+      "next-major",
+      {
+        "name": "beta",
+        "prerelease": true
+      },
+      {
+        "name": "alpha",
+        "prerelease": true
+      }
+    ],
     "plugins": [
@@ -82,4 +96,3 @@ "@semantic-release/commit-analyzer",
       "@semantic-release/github"
-    ],
-    "branch": "master"
+    ]
   },
@@ -86,0 +99,0 @@ "husky": {

README.md

 <h1 align="center">
-  <img src='https://github.com/americanexpress/react-seo/raw/master/react-seo.png' alt="React SEO" width='50%'/>
+  <img src='https://github.com/americanexpress/react-seo/raw/main/react-seo.png' alt="React SEO" width='50%'/>
 </h1>
 
 [![npm version](https://badge.fury.io/js/%40americanexpress%2Freact-seo.svg)](https://badge.fury.io/js/%40americanexpress%2Freact-seo)
-[![Build Status](https://travis-ci.org/americanexpress/react-seo.svg?branch=master)](https://travis-ci.org/americanexpress/react-seo)
+[![Build Status](https://travis-ci.org/americanexpress/react-seo.svg?branch=main)](https://travis-ci.org/americanexpress/react-seo)
 
@@ -122,2 +122,6 @@ > Simple SEO tag manager for React
 SEO.propTypes = {
+  children: oneOfType([
+    arrayOf(node),
+    node,
+  ]),
   title: string,
@@ -221,2 +225,3 @@ description: string,
 SEO.defaultProps = {
+  children: null,
   article: false,
@@ -255,3 +260,3 @@ author: '',
 Any contributions made under this project will be governed by the [Apache License
-2.0](https://github.com/americanexpress/react-seo/blob/master/LICENSE.txt).
+2.0](https://github.com/americanexpress/react-seo/blob/main/LICENSE.txt).
 
@@ -258,0 +263,0 @@ ## 🗣️ Code of Conduct

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

Number of lines in readme file

264

increased by1.93%

Worsened metrics

Total package byte prevSize

52618

decreased by-0.69%

Lines of code

597

decreased by-4.17%

No dependency changes