react-shepherd 3.3.0 → 3.3.4

package/dist/index.d.ts

@@ -2,10 +2,10 @@ import React, { FunctionComponent } from 'react';
 import Shepherd from 'shepherd.js';
 import Step from 'shepherd.js/src/types/step';
 import Tour from 'shepherd.js/src/types/tour';
-interface ShepherdButtonWithType extends Step.StepOptionsButton {
+export interface ShepherdButtonWithType extends Step.StepOptionsButton {
     type?: string;
 }
-interface ShepherdOptionsWithType extends Step.StepOptions {
+export interface ShepherdOptionsWithType extends Step.StepOptions {
     buttons?: ReadonlyArray<Step.StepOptionsButton | ShepherdButtonWithType>;
 }
 interface ShepherdProps {
@@ -15,4 +15,6 @@ interface ShepherdProps {
 declare const ShepherdTourContext: React.Context<Shepherd.Tour | null>;
 declare const ShepherdTourContextConsumer: React.Consumer<Shepherd.Tour | null>;
 export declare const ShepherdTour: FunctionComponent<ShepherdProps>;
+export type { default as Step } from 'shepherd.js/src/types/step';
+export type { default as Tour } from 'shepherd.js/src/types/tour';
 export { ShepherdTourContextConsumer as TourMethods, ShepherdTourContext };

package/package.json

@@ -1,35 +1,34 @@
 {
   "name": "react-shepherd",
-  "version": "3.3.0",
+  "version": "3.3.4",
   "description": "A React wrapper for the site tour library Shepherd",
+  "homepage": "https://shipshapecode.github.io/react-shepherd/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/shipshapecode/react-shepherd.git"
+  },
   "license": "MIT",
-  "repository": "shipshapecode/react-shepherd",
   "main": "dist/Shepherd.js",
   "module": "dist/Shepherd.es.js",
   "jsnext:main": "dist/Shepherd.es.js",
   "types": "dist/index.d.ts",
-  "homepage": "https://shipshapecode.github.io/react-shepherd/",
-  "engines": {
-    "node": ">=8",
-    "npm": ">=5"
-  },
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "prepare": "install-peers",
-    "test": "cross-env CI=1 react-scripts test",
-    "test:watch": "react-scripts test",
     "prebuild": "tsc --project ./tsconfig-declarations.json",
     "build": "rollup -c",
+    "predeploy": "cd example && yarn && yarn build",
+    "deploy": "gh-pages -d example/build",
+    "prepare": "install-peers",
     "problems": "tsc --noEmit",
+    "release": "release-it",
     "start": "rollup -c -w",
-    "predeploy": "cd example && yarn install && yarn run build",
-    "deploy": "gh-pages -d example/build"
+    "test": "cross-env CI=1 react-scripts test",
+    "test:watch": "react-scripts test"
   },
   "dependencies": {
-    "shepherd.js": "^8.0.0"
-  },
-  "peerDependencies": {
-    "react": "^16.8.0",
-    "react-dom": "^16.8.0"
+    "shepherd.js": "^8.0.2"
   },
   "devDependencies": {
     "@babel/core": "^7.5.4",
@@ -52,13 +51,12 @@
     "@babel/plugin-syntax-import-meta": "^7.2.0",
     "@babel/preset-env": "^7.5.4",
     "@babel/preset-react": "^7.0.0",
-    "@sheerun/mutationobserver-shim": "^0.3.3",
     "@svgr/rollup": "^5.1.0",
-    "@testing-library/react": "^9.1.3",
-    "@types/jest": "^25.1.3",
-    "@types/node": "^13.7.1",
-    "@types/react": "^16.9.2",
-    "@types/react-dom": "^16.9.0",
+    "@testing-library/react": "^10.0.0",
+    "@types/jest": "^26.0.10",
+    "@types/node": "^14.6.4",
+    "@types/react": "^17.0.0",
+    "@types/react-dom": "^17.0.0",
     "cross-env": "^7.0.0",
     "eslint": "6.8.0",
     "eslint-config-standard": "^14.0.0",
@@ -67,11 +65,13 @@
     "eslint-plugin-node": "^11.0.0",
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-react": "^7.14.2",
-    "eslint-plugin-standard": "^4.0.0",
+    "eslint-plugin-standard": "^5.0.0",
     "gh-pages": "^2.0.1",
     "install-peers-cli": "^2.2.0",
-    "react-scripts": "^3.4.0",
-    "react-syntax-highlighter": "^12.2.1",
+    "react-scripts": "^3.4.3",
+    "react-syntax-highlighter": "^15.3.0",
+    "release-it": "^14.0.2",
+    "release-it-lerna-changelog": "^3.1.0",
     "rollup": "^2.6.1",
     "rollup-plugin-babel": "^4.3.3",
     "rollup-plugin-commonjs": "^10.0.1",
@@ -80,14 +80,18 @@
     "rollup-plugin-postcss": "^3.1.1",
     "rollup-plugin-typescript": "^1.0.1",
     "rollup-plugin-url": "^3.0.0",
-    "tslib": "^1.10.0",
-    "typescript": "^3.6.2"
+    "tslib": "^2.0.1",
+    "typescript": "^4.0.2"
   },
-  "files": [
-    "dist"
-  ],
-  "volta": {
-    "node": "10.16.3",
-    "yarn": "1.22.0"
+  "peerDependencies": {
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
+  },
+  "engines": {
+    "node": ">=8",
+    "npm": ">=5"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
   }
 }

package/README.md

@@ -1,137 +0,0 @@
-# react-shepherd
-
-<div>
-  <a href="https://shipshape.io">
-    <img align="left" src="http://i.imgur.com/DWHQjA5.png" alt="Ship Shape" width="50" height="50"/>
-  </a>
-
-**[react-shepherd is built and maintained by Ship Shape. Contact us for web app consulting, development, and training for your project](https://shipshape.io/)**.
-
-</div>
-
-[![NPM](https://img.shields.io/npm/v/react-shepherd.svg)](https://www.npmjs.com/package/react-shepherd)
-[![Build Status](https://travis-ci.org/shipshapecode/react-shepherd.svg)](https://travis-ci.org/shipshapecode/react-shepherd)
-[![Maintainability](https://api.codeclimate.com/v1/badges/d5273e1d465352a6df4e/maintainability)](https://codeclimate.com/github/shipshapecode/react-shepherd/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/d5273e1d465352a6df4e/test_coverage)](https://codeclimate.com/github/shipshapecode/react-shepherd/test_coverage)
-[![Greenkeeper badge](https://badges.greenkeeper.io/shipshapecode/react-shepherd.svg)](https://greenkeeper.io/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
-
-This is a React wrapper for the [Shepherd](https://github.com/shipshapecode/shepherd), site tour, library.
-It's mainly a wrapper around the Shepherd library that exposes the tour object and methods to the context object
-that can be passed into props for dynamic interactivity.
-
-## Install
-
-```bash
-npm install --save react-shepherd
-```
-
-## Usage
-
-```jsx
-import React, { Component } from 'react'
-import {ShepherdTour, ShepherdTourContext} from 'react-shepherd'
-import newSteps from './steps'
-
-const tourOptions = {
-  defaultStepOptions: {
-    cancelIcon: {
-      enabled: true
-    }
-  },
-  useModalOverlay: true
-};
-
-function Button() {
-  const tour = useContext(ShepherdTourContext);
-
-  return (
-    <button className="button dark" onClick={tour.start}>
-      Start Tour
-    </button>
-  );
-}
-
-class App extends Component {
-  render() {
-    return (
-      <div>
-        <ShepherdTour steps={newSteps} tourOptions={tourOptions}>
-          <Button />
-        </ShepherdTour>
-      </div>
-    );
-}
-```
-
-## Configuration
-
-The following configuration options for a tour can be set on the ShepherdTour to control the way that Shepherd is used. This is simply a POJO passed to Shepherd to use the options noted in the Shepherd Tour [options](https://shepherdjs.dev/docs/Tour.html).
-**The only required option is `steps`, which is an array passed to the props.**
-
-### tourOptions
-
-`PropTypes.object`
-Used to set the options that will be applied to each step by default. You can pass in any of the options that you can with Shepherd.
-
-### steps
-
-`PropTypes.array`
-You must pass an array of steps to `steps`, something like this:
-
-```js
-const steps = [
-  {
-    id: 'intro',
-      attachTo: '.first-element bottom',
-      beforeShowPromise: function() {
-        return new Promise(function(resolve) {
-          setTimeout(function() {
-            window.scrollTo(0, 0);
-            resolve();
-          }, 500);
-        });
-      },
-      buttons: [
-        {
-          classes: 'shepherd-button-secondary',
-          text: 'Exit',
-          type: 'cancel'
-        },
-        {
-          classes: 'shepherd-button-primary',
-          text: 'Back',
-          type: 'back'
-        },
-        {
-          classes: 'shepherd-button-primary',
-          text: 'Next',
-          type: 'next'
-        }
-      ],
-      classes: 'custom-class-name-1 custom-class-name-2',
-      highlightClass: 'highlight',
-      scrollTo: false,
-      showCancelLink: true,
-      title: 'Welcome to React-Shepherd!',
-      text: ['React-Shepherd is a JavaScript library for guiding users through your React app.'],
-      when: {
-        show: () => {
-          console.log('show step');
-        },
-        hide: () => {
-          console.log('hide step');
-        }
-      }
-  },
-  ...
-]);
-```
-
-## Steps
-
-The options are the same as Shepherd [options](https://shepherdjs.dev/docs/Step.html).
-
-## License
-
-MIT