@swipefindercom/finder-sdk 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 SwipeFinder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,108 @@
+# @swipefindercom/finder-sdk
+
+Embed interactive swipeable card feeds on any website or React app.
+
+## Installation
+
+```bash
+npm install @swipefindercom/finder-sdk
+```
+
+## Usage
+
+### Vanilla JS / Any framework (SDK)
+
+The SDK build bundles everything (including React) so it works anywhere — plain HTML, Vue, Angular, etc.
+
+```html
+<div id="swipefinder"></div>
+
+<script type="module">
+  import { initSwipeFinder } from '@swipefindercom/finder-sdk';
+
+  const cleanup = initSwipeFinder({
+    backendUrl: 'https://api.swipefinder.com',
+    finderId: 'your-finder-id',
+    element: document.getElementById('swipefinder'),
+  });
+
+  // Call cleanup() to unmount
+</script>
+```
+
+### UMD (script tag)
+
+```html
+<div id="swipefinder"></div>
+
+<script src="https://unpkg.com/@swipefindercom/finder-sdk"></script>
+<script>
+  const cleanup = SwipeFinderSDK.initSwipeFinder({
+    backendUrl: 'https://api.swipefinder.com',
+    finderId: 'your-finder-id',
+    element: document.getElementById('swipefinder'),
+  });
+</script>
+```
+
+### React Component
+
+For React apps — uses your app's React instance (no duplicate React bundle).
+
+```bash
+npm install @swipefindercom/finder-sdk react react-dom
+```
+
+```tsx
+import { SwipeFinder } from '@swipefindercom/finder-sdk/react';
+
+function App() {
+  return (
+    <SwipeFinder
+      backendUrl="https://api.swipefinder.com"
+      finderId="your-finder-id"
+    />
+  );
+}
+```
+
+## API
+
+### `initSwipeFinder(options)`
+
+| Option       | Type          | Required | Description                        |
+| ------------ | ------------- | -------- | ---------------------------------- |
+| `backendUrl` | `string`      | ✅       | Backend API URL                    |
+| `finderId`   | `string`      | ✅       | Finder identifier                  |
+| `element`    | `HTMLElement`  | ✅       | DOM element to mount into          |
+
+Returns a `() => void` cleanup function that unmounts the widget.
+
+### `<SwipeFinder />` (React)
+
+| Prop         | Type     | Required | Description                        |
+| ------------ | -------- | -------- | ---------------------------------- |
+| `backendUrl` | `string` | ✅       | Backend API URL                    |
+| `finderId`   | `string` | ✅       | Finder identifier                  |
+| `className`  | `string` | ❌       | Additional CSS class               |
+
+## Builds
+
+| Entry                   | Format    | React bundled? | Use case                        |
+| ----------------------- | --------- | -------------- | ------------------------------- |
+| `@swipefindercom/finder-sdk`        | ESM / UMD | ✅ Yes         | Vanilla JS, Vue, Angular, etc.  |
+| `@swipefindercom/finder-sdk/react`  | ESM / CJS | ❌ Peer dep    | React apps                      |
+
+## Development
+
+```bash
+npm run dev            # Dev server on :3010
+npm run storybook      # Storybook on :6006
+npm run build:all      # Build SDK + React + types
+npm run test:e2e       # Playwright E2E tests
+```
+
+## License
+
+MIT © [SwipeFinder](https://swipefinder.com)
+