@swipefindercom/finder-sdk 1.0.13 → 1.0.14
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/README.md +1 -30
- package/dist/finder-sdk.esm.js +325 -297
- package/dist/finder-sdk.umd.js +1 -1
- package/dist/types/components/SwipeTutorialOverlay/SwipeTutorialOverlay.d.ts +19 -6
- package/dist/types/components/SwipeTutorialOverlay/SwipeTutorialOverlay.d.ts.map +1 -1
- package/dist/types/components/SwipeableFeed/SwipeableFeed.d.ts +5 -7
- package/dist/types/components/SwipeableFeed/SwipeableFeed.d.ts.map +1 -1
- package/dist/types/containers/InteractiveFeed/InteractiveFeed.d.ts +1 -1
- package/dist/types/containers/InteractiveFeed/InteractiveFeed.d.ts.map +1 -1
- package/dist/types/containers/MainBootstrap/MainBootstrap.d.ts +1 -4
- package/dist/types/containers/MainBootstrap/MainBootstrap.d.ts.map +1 -1
- package/dist/types/containers/SwippingJourney/SwippingJourney.d.ts.map +1 -1
- package/dist/types/contexts/DataContext.d.ts +0 -3
- package/dist/types/contexts/DataContext.d.ts.map +1 -1
- package/dist/types/contexts/UIContext.d.ts +3 -0
- package/dist/types/contexts/UIContext.d.ts.map +1 -1
- package/dist/types/contexts/index.d.ts +0 -3
- package/dist/types/contexts/index.d.ts.map +1 -1
- package/dist/types/sdk/index.d.ts +1 -8
- package/dist/types/sdk/index.d.ts.map +1 -1
- package/dist/types/services/DataService.d.ts +0 -9
- package/dist/types/services/DataService.d.ts.map +1 -1
- package/dist/types/types/FeedUIConfig.d.ts +15 -1
- package/dist/types/types/FeedUIConfig.d.ts.map +1 -1
- package/package.json +2 -22
- package/dist/finder-sdk-react.cjs.js +0 -1
- package/dist/finder-sdk-react.esm.js +0 -45816
package/README.md
CHANGED
|
@@ -45,26 +45,6 @@ The SDK build bundles everything (including React) so it works anywhere — plai
|
|
|
45
45
|
</script>
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
### React Component
|
|
49
|
-
|
|
50
|
-
For React apps — uses your app's React instance (no duplicate React bundle).
|
|
51
|
-
|
|
52
|
-
```bash
|
|
53
|
-
npm install @swipefindercom/finder-sdk react react-dom
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
```tsx
|
|
57
|
-
import { SwipeFinder } from '@swipefindercom/finder-sdk/react';
|
|
58
|
-
|
|
59
|
-
function App() {
|
|
60
|
-
return (
|
|
61
|
-
<SwipeFinder
|
|
62
|
-
backendUrl="https://api.swipefinder.com"
|
|
63
|
-
finderId="your-finder-id"
|
|
64
|
-
/>
|
|
65
|
-
);
|
|
66
|
-
}
|
|
67
|
-
```
|
|
68
48
|
|
|
69
49
|
## API
|
|
70
50
|
|
|
@@ -78,27 +58,18 @@ function App() {
|
|
|
78
58
|
|
|
79
59
|
Returns a `() => void` cleanup function that unmounts the widget.
|
|
80
60
|
|
|
81
|
-
### `<SwipeFinder />` (React)
|
|
82
|
-
|
|
83
|
-
| Prop | Type | Required | Description |
|
|
84
|
-
| ------------ | -------- | -------- | ---------------------------------- |
|
|
85
|
-
| `backendUrl` | `string` | ✅ | Backend API URL |
|
|
86
|
-
| `finderId` | `string` | ✅ | Finder identifier |
|
|
87
|
-
| `className` | `string` | ❌ | Additional CSS class |
|
|
88
|
-
|
|
89
61
|
## Builds
|
|
90
62
|
|
|
91
63
|
| Entry | Format | React bundled? | Use case |
|
|
92
64
|
| ----------------------- | --------- | -------------- | ------------------------------- |
|
|
93
65
|
| `@swipefindercom/finder-sdk` | ESM / UMD | ✅ Yes | Vanilla JS, Vue, Angular, etc. |
|
|
94
|
-
| `@swipefindercom/finder-sdk/react` | ESM / CJS | ❌ Peer dep | React apps |
|
|
95
66
|
|
|
96
67
|
## Development
|
|
97
68
|
|
|
98
69
|
```bash
|
|
99
70
|
npm run dev # Dev server on :3010
|
|
100
71
|
npm run storybook # Storybook on :6006
|
|
101
|
-
npm run build:all # Build SDK +
|
|
72
|
+
npm run build:all # Build SDK + types
|
|
102
73
|
npm run test:e2e # Playwright E2E tests
|
|
103
74
|
```
|
|
104
75
|
|