react-shepherd 4.2.0 → 4.3.0

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import React, { FC } from 'react';
 import Shepherd from 'shepherd.js';
 import Step from 'shepherd.js/src/types/step';
 import Tour from 'shepherd.js/src/types/tour';
-declare type StepType = 'back' | 'cancel' | 'next';
+type StepType = 'back' | 'cancel' | 'next';
 export interface ShepherdButtonWithType extends Step.StepOptionsButton {
     type?: StepType;
 }
@@ -16,6 +16,7 @@ interface ShepherdProps {
 }
 declare const ShepherdTourContext: React.Context<Shepherd.Tour | null>;
 declare const ShepherdTourContextConsumer: React.Consumer<Shepherd.Tour | null>;
+export declare const useShepherdTour: ({ tourOptions, steps }: Pick<ShepherdProps, 'steps' | 'tourOptions'>) => Shepherd.Tour;
 export declare const ShepherdTour: FC<ShepherdProps>;
 export type { default as Step } from 'shepherd.js/src/types/step';
 export type { default as Tour } from 'shepherd.js/src/types/tour';

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "react-shepherd",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "A React wrapper for the site tour library Shepherd",
-  "homepage": "https://shipshapecode.github.io/react-shepherd/",
+  "homepage": "https://react-shepherd.vercel.app/",
   "repository": {
     "type": "git",
     "url": "https://github.com/shipshapecode/react-shepherd.git"
@@ -54,8 +54,8 @@
     "@babel/plugin-syntax-import-meta": "^7.2.0",
     "@babel/preset-env": "^7.5.4",
     "@babel/preset-react": "^7.0.0",
-    "@svgr/rollup": "^6.2.1",
-    "@testing-library/react": "^13.3.0",
+    "@svgr/rollup": "^8.1.0",
+    "@testing-library/react": "^14.0.0",
     "@types/jest": "^29.0.0",
     "@types/node": "^18.0.3",
     "@types/react": "^18.0.15",
@@ -92,7 +92,7 @@
     "react-dom": "^17.0.2 || 18.x"
   },
   "engines": {
-    "node": ">=14",
+    "node": ">=16",
     "npm": ">=7"
   },
   "publishConfig": {

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"mappings":";;;;AAKA,uCAAwC,SAAQ,IAAI,CAAC,iBAAiB;IACpE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,wCAAyC,SAAQ,IAAI,CAAC,WAAW;IAC/D,OAAO,CAAC,EAAE,aAAa,CAAC,KAAK,iBAAiB,GAAG,sBAAsB,CAAC,CAAC;CAC1E;AAED;IACE,KAAK,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;IACtC,WAAW,EAAE,KAAK,WAAW,CAAC;CAC/B;AAED,OAAA,MAAM,wDAA4D,CAAC;AACnE,OAAA,MAAM,iDAA0D,CAAC;AAwCjE,OAAO,MAAM,cAAc,kBAAkB,aAAa,CAezD,CAAC;AAEF,YAAY,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAClE,YAAY,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,4BAA4B,CAAC","sources":["packages/lib/src/src/index.tsx","packages/lib/src/index.tsx"],"sourcesContent":[null,"import React, { FunctionComponent, useMemo } from 'react';\nimport Shepherd from 'shepherd.js';\nimport Step from 'shepherd.js/src/types/step';\nimport Tour from 'shepherd.js/src/types/tour';\n\nexport interface ShepherdButtonWithType extends Step.StepOptionsButton {\n  type?: string;\n}\n\nexport interface ShepherdOptionsWithType extends Step.StepOptions {\n  buttons?: ReadonlyArray<Step.StepOptionsButton | ShepherdButtonWithType>;\n}\n\ninterface ShepherdProps {\n  steps: Array<ShepherdOptionsWithType>;\n  tourOptions: Tour.TourOptions;\n}\n\nconst ShepherdTourContext = React.createContext<Tour | null>(null);\nconst ShepherdTourContextConsumer = ShepherdTourContext.Consumer;\n\n/**\n * Take a set of steps and formats to use actions on the buttons in the current context\n * @param {Array} steps\n * @param {Array} tour\n * @private\n */\nconst addSteps = (steps: Array<Step.StepOptions>, tour: Tour) => {\n  // Return nothing if there are no steps\n  if (!steps.length) {\n    return [];\n  }\n\n  const parsedStepsforAction = steps.map((step: Step.StepOptions): Step.StepOptions => {\n    const { buttons } = step;\n\n    if (buttons) {\n      step.buttons = buttons.map((button: ShepherdButtonWithType) => {\n        const { action, classes, disabled, label, secondary, text, type } = button;\n        return {\n          // TypeScript doesn't have great support for dynamic method calls with\n          // bracket notation, so we use the `any` escape hatch\n          action: (tour as any)[type!] || action,\n          classes,\n          disabled,\n          label,\n          secondary,\n          text,\n          type\n        };\n      });\n    }\n\n    return step;\n  });\n\n  parsedStepsforAction.forEach((step: any) => tour.addStep(step));\n};\n\nexport const ShepherdTour: FunctionComponent<ShepherdProps> = props => {\n  const { tourOptions, steps } = props;\n  const tourObject = useMemo(() => {\n    const tourObject = new Shepherd.Tour(tourOptions);\n\n    addSteps(steps, tourObject);\n\n    return tourObject;\n  }, [tourOptions, steps]);\n\n  return (\n    <ShepherdTourContext.Provider value={tourObject}>\n      {props.children}\n    </ShepherdTourContext.Provider>\n  );\n};\n\nexport type { default as Step } from 'shepherd.js/src/types/step';\nexport type { default as Tour } from 'shepherd.js/src/types/tour';\nexport { ShepherdTourContextConsumer as TourMethods, ShepherdTourContext };\n"],"names":[],"version":3,"file":"index.d.ts.map","sourceRoot":"../../../"}