react-shepherd 6.1.8 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +53 -20
- package/README.md +8 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1193 -3689
- package/dist/index.umd.cjs +2 -26
- package/package.json +20 -17
package/LICENSE.md
CHANGED
|
@@ -1,23 +1,56 @@
|
|
|
1
|
-
# License
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
1
|
+
# Shepherd.js License
|
|
2
|
+
|
|
3
|
+
Shepherd.js is dual-licensed under **AGPL-3.0** (for open source and non-commercial use) and a **Commercial License** (for commercial use).
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
🆓 Free Use - AGPL-3.0 License
|
|
7
|
+
You may use Shepherd.js **FREE OF CHARGE** under the AGPL-3.0 license if you are:
|
|
8
|
+
✅ Open Source Projects
|
|
9
|
+
- Your project is open source and licensed under an AGPL-compatible license (GPL, AGPL, etc.)
|
|
10
|
+
- Your complete source code is publicly available
|
|
11
|
+
✅ Personal & Non-Commercial Use
|
|
12
|
+
- Personal projects, portfolios, and hobby websites
|
|
13
|
+
- Educational purposes (students, teachers, coursework)
|
|
14
|
+
- Academic research projects
|
|
15
|
+
✅ Evaluation & Testing
|
|
16
|
+
- Evaluating Shepherd.js for up to 30 days
|
|
17
|
+
- Development, testing, and staging environments during evaluation
|
|
18
|
+
- Proof-of-concept and demo projects
|
|
19
|
+
**Important:** If you use Shepherd.js under AGPL-3.0, you must:
|
|
20
|
+
- Make your complete source code available if you distribute or provide your software over a network
|
|
21
|
+
- License your code under AGPL-3.0 or a compatible license
|
|
22
|
+
- Comply with all AGPL-3.0 terms (see full license text below)
|
|
23
|
+
---
|
|
24
|
+
💳 Commercial License Required
|
|
25
|
+
You **must purchase a commercial license** at [shepherdjs.dev/pricing](https://shepherdjs.dev/pricing) if:
|
|
26
|
+
❌ Commercial Products & Services
|
|
27
|
+
- You're building a commercial product, application, SaaS, or website that generates revenue
|
|
28
|
+
- Your company generates revenue (even if the specific project using Shepherd.js does not)
|
|
29
|
+
- You're using Shepherd.js in any customer-facing commercial application
|
|
30
|
+
❌ Closed-Source Use
|
|
31
|
+
- You cannot or don't want to open-source your code under AGPL-3.0
|
|
32
|
+
- You want to keep your source code proprietary
|
|
33
|
+
- You want to avoid AGPL's source code disclosure requirements
|
|
34
|
+
❌ White-Label, Resale, or OEM Use
|
|
35
|
+
- You're embedding Shepherd.js in a product you sell or distribute
|
|
36
|
+
- You're offering Shepherd.js as part of a commercial service or hosting
|
|
37
|
+
- You're using Shepherd.js in a product sold to other businesses
|
|
38
|
+
❌ Internal Business Tools
|
|
39
|
+
- You're using Shepherd.js for internal tools, dashboards, or admin panels in a revenue-generating company
|
|
40
|
+
- Even if the tool is not customer-facing, commercial licenses are required for for-profit companies
|
|
41
|
+
**Why Commercial License?**
|
|
42
|
+
- ✅ No AGPL obligations - keep your code proprietary
|
|
43
|
+
- ✅ Legal protection and indemnification
|
|
44
|
+
- ✅ Priority support and updates
|
|
45
|
+
- ✅ Lifetime license with no recurring fees
|
|
46
|
+
[**Purchase Commercial License →**](https://shepherdjs.dev/pricing)
|
|
47
|
+
---
|
|
48
|
+
❓ Still Not Sure?
|
|
49
|
+
If you're unsure whether you need a commercial license:
|
|
50
|
+
- **Contact us:** [ahoy@shipshape.io](mailto:ahoy@shipshape.io)
|
|
51
|
+
- **View pricing:** [shepherdjs.dev/pricing](https://shepherdjs.dev/pricing)
|
|
52
|
+
**When in doubt:** If your organization generates revenue, you likely need a commercial license.
|
|
53
|
+
---
|
|
21
54
|
|
|
22
55
|
### GNU AFFERO GENERAL PUBLIC LICENSE
|
|
23
56
|
|
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ npm install --save react-shepherd
|
|
|
20
20
|
|
|
21
21
|
```tsx
|
|
22
22
|
import { Component, useContext } from 'react';
|
|
23
|
-
import { ShepherdJourneyProvider, useShepherd } from '
|
|
23
|
+
import { ShepherdJourneyProvider, useShepherd } from 'react-shepherd';
|
|
24
24
|
import newSteps from './steps';
|
|
25
25
|
|
|
26
26
|
const tourOptions = {
|
|
@@ -63,4 +63,10 @@ The following configuration options for a tour can be set on the `useShepherd` h
|
|
|
63
63
|
|
|
64
64
|
## License
|
|
65
65
|
|
|
66
|
-
|
|
66
|
+
`react-shepherd` is licensed under **AGPL-3.0** (for open source and non-commercial use) with a **Commercial License** available for commercial use.
|
|
67
|
+
|
|
68
|
+
- **Free** for open source and non-commercial projects under AGPL-3.0
|
|
69
|
+
- **Commercial license required** for commercial products and revenue-generating companies
|
|
70
|
+
|
|
71
|
+
📄 [Read License Details](../../LICENSE.md)
|
|
72
|
+
💳 [Purchase Commercial License](https://shepherdjs.dev/pricing)
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Consumer } from 'react';
|
|
2
2
|
import { Context } from 'react';
|
|
3
3
|
import { default as default_2 } from 'shepherd.js';
|
|
4
|
-
import { JSX
|
|
4
|
+
import { JSX } from 'react/jsx-runtime';
|
|
5
5
|
import { ReactNode } from 'react';
|
|
6
6
|
import { ShepherdBase } from 'shepherd.js';
|
|
7
7
|
|
|
@@ -15,7 +15,7 @@ export declare const ShepherdJourneyContext: Context<ShepherdContextType | undef
|
|
|
15
15
|
|
|
16
16
|
export declare const ShepherdJourneyProvider: ({ children }: {
|
|
17
17
|
children?: ReactNode;
|
|
18
|
-
}) =>
|
|
18
|
+
}) => JSX.Element;
|
|
19
19
|
|
|
20
20
|
export declare const useShepherd: () => ShepherdBase;
|
|
21
21
|
|