@dismissible/react-client 0.3.1 → 0.3.2-canary.2.38782c4

package/README.md

@@ -1,6 +1,8 @@
 # @dismissible/react-client
 
-A React component library for creating dismissible UI elements with persistent state management.
+A React component library for creating dismissible UI elements with persistent state management. 
+
+Use this in combination with [dismissible.io](https://dismissible.io). Get your free account now!
 
 🌐 **[dismissible.io](https://dismissible.io)** | 💰 **[View Pricing](https://dismissible.io/pricing)** | 📖 **[Documentation](https://docs.dismissible.io)**
 
@@ -369,32 +371,6 @@ function Dashboard() {
 }
 ```
 
-### Conditional Dismissible Content
-
-```tsx
-import { Dismissible } from '@dismissible/react-client';
-
-function ConditionalBanner({ user }) {
-  // Only show to new users
-  if (user.isReturning) {
-    return null;
-  }
-
-  return (
-    <Dismissible id={`onboarding-${user.id}`}>
-      <div className="onboarding-tips">
-        <h3>Getting Started</h3>
-        <ul>
-          <li>Complete your profile</li>
-          <li>Connect with friends</li>
-          <li>Explore our features</li>
-        </ul>
-      </div>
-    </Dismissible>
-  );
-}
-```
-
 ### User-Specific vs Anonymous Dismissible Items
 
 The behavior changes based on whether JWT authentication is configured:
@@ -422,18 +398,6 @@ function AuthenticatedApp() {
     </DismissibleProvider>
   );
 }
-
-// Without JWT - dismissible state is account-level (anonymous)
-function AnonymousApp() {
-  return (
-    <div>
-      {/* These will be dismissed for all users of this account */}
-      <Dismissible id="general-announcement">
-        <div>Site maintenance scheduled</div>
-      </Dismissible>
-    </div>
-  );
-}
 ```
 
 ### Error Handling with ignoreErrors
@@ -455,18 +419,6 @@ function RobustBanner() {
     </Dismissible>
   );
 }
-
-// Default behavior - hide content on errors
-function StandardBanner() {
-  return (
-    <Dismissible id="promo-banner">
-      <div className="promo">
-        <h3>Special Offer!</h3>
-        <p>Get 50% off your first order</p>
-      </div>
-    </Dismissible>
-  );
-}
 ```
 
 ### Async JWT Authentication Examples
@@ -630,79 +582,6 @@ const AuthProvider: React.FC<DismissibleProviderProps> = ({ children, jwt }) =>
 };
 ```
 
-## Development
-
-### Prerequisites
-
-- Node.js 18+
-- npm or yarn
-
-### Setup
-
-```bash
-# Clone the repository
-git clone https://github.com/your-org/dismissible.git
-cd dismissible/react-client
-
-# Install dependencies
-npm install
-
-# Start development server
-npm run dev
-```
-
-### Available Scripts
-
-- `npm run dev` - Start development server with Vite
-- `npm run build` - Build the library for production
-- `npm run test` - Run tests with Vitest
-- `npm run test:watch` - Run tests in watch mode
-- `npm run lint` - Run ESLint
-- `npm run format` - Format code with Prettier
-- `npm run storybook` - Start Storybook development server
-- `npm run build-storybook` - Build Storybook for production
-
-### Testing
-
-```bash
-# Run all tests
-npm run test
-
-# Run tests in watch mode
-npm run test:watch
-
-# Run tests with coverage
-npm run test -- --coverage
-```
-
-### Storybook
-
-The library includes Storybook for component development and documentation:
-
-```bash
-npm run storybook
-```
-
-## Contributing
-
-We welcome contributions! Please see our [Contributing Guide](../CONTRIBUTING.md) for details.
-
-### Development Workflow
-
-1. Fork the repository
-2. Create a feature branch: `git checkout -b feature/my-new-feature`
-3. Make your changes
-4. Add tests for new functionality
-5. Run tests: `npm run test`
-6. Run linting: `npm run lint`
-7. Commit your changes: `git commit -am 'Add new feature'`
-8. Push to the branch: `git push origin feature/my-new-feature`
-9. Submit a pull request
-
-## License
-
-MIT © [Dismissible](https://github.com/joshystuart)
-
 ## Support
 
 - 📖 [Documentation](https://docs.dismissible.io)

package/dist/contexts/DismissibleContext.d.ts

@@ -5,6 +5,7 @@ import { DismissibleContextValue } from '../types/dismissible.types';
 export declare const DismissibleContext: import('react').Context<DismissibleContextValue | null>;
 /**
  * Hook to consume the DismissibleContext
- * @returns The context value or null if not within a provider
+ * @throws Error if used outside of a DismissibleProvider
+ * @returns The context value
  */
-export declare const useDismissibleContext: () => DismissibleContextValue | null;
+export declare const useDismissibleContext: () => DismissibleContextValue;

package/dist/contexts/DismissibleProvider.d.ts

@@ -6,12 +6,13 @@ import { DismissibleProviderProps } from '../types/dismissible.types';
  * @example
  * ```tsx
  * // With static JWT
- * <DismissibleProvider jwt="eyJhbGciOiJ..." baseUrl="https://api.dismissible.io">
+ * <DismissibleProvider userId="user-123" jwt="eyJhbGciOiJ..." baseUrl="https://api.dismissible.io">
  *   <App />
  * </DismissibleProvider>
  *
  * // With synchronous JWT function
  * <DismissibleProvider
+ *   userId="user-123"
  *   jwt={() => getAccessToken()}
  *   baseUrl="https://api.dismissible.io"
  * >
@@ -20,6 +21,7 @@ import { DismissibleProviderProps } from '../types/dismissible.types';
  *
  * // With asynchronous JWT function
  * <DismissibleProvider
+ *   userId="user-123"
  *   jwt={async () => await fetchAccessToken()}
  *   baseUrl="https://api.dismissible.io"
  * >