react-twitter-widgets - npm Package Compare versions

Comparing version 1.7.1 to 1.8.0

package.json

 {
   "name": "react-twitter-widgets",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "description": "Twitter widgets as React components",
-  "main": "dist/index.js",
+  "author": "Andrew Suzuki",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/andrewsuzuki/react-twitter-widgets/issues"
+  },
+  "homepage": "https://github.com/andrewsuzuki/react-twitter-widgets",
+  "main": "lib/index.js",
+  "module": "es/index.js",
   "types": "src/index.d.ts",
+  "files": [
+    "css",
+    "es",
+    "lib",
+    "umd"
+  ],
+  "dependencies": {
+    "loadjs": "^4.2.0",
+    "lodash.clonedeep": "^4.5.0",
+    "lodash.isequal": "^4.5.0"
+  },
+  "devDependencies": {
+    "nwb": "0.25.x",
+    "react": "^16.13.1",
+    "react-dom": "^16.13.1"
+  },
+  "peerDependencies": {
+    "react": "^16.8.0"
+  },
   "scripts": {
-    "clean": "rimraf dist",
-    "build": "npm run clean && babel src --out-dir dist",
+    "build": "nwb build-react-component",
+    "clean": "nwb clean-module && nwb clean-demo",
     "prepublishOnly": "npm run build",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "eslint src"
+    "start": "nwb serve-react-demo",
+    "test": "nwb test-react",
+    "test:coverage": "nwb test-react --coverage",
+    "test:watch": "nwb test-react --server"
   },
@@ -33,35 +61,3 @@ "repository": {
     "mention"
-  ],
-  "author": "Andrew Suzuki",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/andrewsuzuki/react-twitter-widgets/issues"
-  },
-  "homepage": "https://github.com/andrewsuzuki/react-twitter-widgets#readme",
-  "devDependencies": {
-    "babel-cli": "^6.24.1",
-    "babel-core": "^6.24.1",
-    "babel-eslint": "^7.0.0",
-    "babel-preset-es2015": "^6.18.0",
-    "babel-preset-react": "^6.16.0",
-    "babel-preset-stage-0": "^6.16.0",
-    "eslint": "^3.19.0",
-    "eslint-config-airbnb": "^14.1.0",
-    "eslint-plugin-babel": "^4.0.0",
-    "eslint-plugin-import": "^2.2.0",
-    "eslint-plugin-jsx-a11y": "^4.0.0",
-    "eslint-plugin-react": "^6.10.3",
-    "react": "^15.3.0",
-    "rimraf": "^2.5.2",
-    "@types/react": "^16.0.5"
-  },
-  "dependencies": {
-    "exenv": "^1.2.1",
-    "lodash": "^4.17.4",
-    "prop-types": "^15.3.0",
-    "scriptjs": "^2.5.8"
-  },
-  "peerDependencies": {
-    "react": "^15.3.0 || ^16.0.0"
-  }
+  ]
 }

README.md

 # react-twitter-widgets
 
-Alleviates the need for Twitter's default 2008-style widget snippets.
+Quick and easy Twitter widgets for React.
 
@@ -17,41 +17,54 @@ Available widgets: `Timeline`, `Share`, `Follow`, `Hashtag`, `Mention`, `Tweet`.
 
-[Click here](./site/screenshot.png) for a preview of all available widgets with example code.
-
 ```javascript
 import { Timeline } from 'react-twitter-widgets'
-// var Timeline = require('react-twitter-widgets').Timeline
 
-ReactDOM.render((
-  <Timeline
-    dataSource={{
-      sourceType: 'profile',
-      screenName: 'twitterdev'
-    }}
-    options={{
-      username: 'TwitterDev',
-      height: '400'
-    }}
-    onLoad={() => console.log('Timeline is loaded!')}
-  />
-), document.getElementById('root'))
+// Timeline (with options)
+<Timeline
+  dataSource={{
+    sourceType: 'profile',
+    screenName: 'TwitterDev'
+  }}
+  options={{
+    height: '400'
+  }}
+  // Optional
+  // onLoad={() => console.log('Timeline is loaded!')}
+/>
+
+// Tweet (without options)
+<Tweet tweetId="841418541026877441" />
 ```
 
-# Usage
+## Usage
 
+[**Official Twitter Documentation**](https://developer.twitter.com/en/docs/twitter-for-websites/javascript-api/guides/scripting-factory-functions)
+
 Available widgets: `Timeline`, `Share`, `Follow`, `Hashtag`, `Mention`, `Tweet`
 
-All widgets take an optional options object prop. To learn more about the available options (height, width, align, count, etc), see [this link](https://dev.twitter.com/web/javascript/creating-widgets).
+**`Timeline`** requires a `dataSource` object prop.
+The source type can be `profile`, `likes`, `list`, `collection`, or `url`.
+They each require their own co-fields; see Twitter documentation.
 
-`Timeline` requires a `dataSource` object prop, see [here](https://dev.twitter.com/web/javascript/creating-widgets#timelines) for info. The source type can be profile, likes, list, collection, URL, or legacy widget configuration.
+**`Share`** requires a `url` prop.
 
-`Share` requires a `url` prop.
+**`Follow`** and **`Mention`** require a `username` prop. NOTE that the Twitter
+documentation now refers to this as *screenName*.
 
-`Follow` and `Mention` require a `username` prop.
+**`Hashtag`** requires a `hashtag` prop.
 
-`Hashtag` requires a `hashtag` prop.
+**`Tweet`** requires a `tweetId` prop. Ex. `'511181794914627584'`
 
-`Tweet` requires a `tweetId` prop. Ex. `'511181794914627584'`
+All widgets accept an optional `options` object prop. To learn more about the
+available options (height, width, align, count, etc), see the Twitter
+documentation.
 
-All widgets accept an optional `onLoad` callback, which is called every time the widget is loaded/reloaded (both on inital load and updates).
+All widgets accept an optional `onLoad` callback, which is called every time
+the widget is loaded/reloaded (both on inital load and updates).
 
+## Further Information
+
+* This library loads the remote *Twitter for Websites* script.
+* Twitter widgets are only loaded in the browser. A blank div will be rendered during SSR.
+* Unfortunately, widget errors cannot be handled by this library. Twitter catches and logs any errors before they can bubble up. Therefore, if the remote library can't be loaded or if a supplied screen name does not exist, the widget will render as a blank div.
+
 ## Contributing
@@ -58,0 +71,0 @@

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

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

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Dependency count

4

decreased by-20%

Dev dependency count

3

decreased by-80%

Lines of code

5101

increased by379.42%

Number of lines in readme file

84

increased by18.31%

Worsened metrics

Total package byte prevSize

382300

decreased by-74.49%

Number of package files

9

decreased by-76.92%

Number of medium supply chain risk alerts

9

increased by800%

Dependency changes

• + Addedloadjs@^4.2.0

• + Addedlodash.clonedeep@^4.5.0

• + Addedlodash.isequal@^4.5.0

• + Addedloadjs@4.3.0(transitive)

• + Addedlodash.clonedeep@4.5.0(transitive)

• + Addedlodash.isequal@4.5.0(transitive)

• - Removedexenv@^1.2.1

• - Removedlodash@^4.17.4

• - Removedprop-types@^15.3.0

• - Removedscriptjs@^2.5.8

• - Removedexenv@1.2.2(transitive)

• - Removedlodash@4.17.21(transitive)

• - Removedscriptjs@2.5.9(transitive)