tour-guide-live 0.1.0

package/README.md

@@ -0,0 +1,55 @@
+# tour-guide-live
+
+Lightweight React SDK for embedding in-app product tours powered by [Tour Guide Live](https://github.com/masonbullimore/tour-guide-live).
+
+## Install
+
+```bash
+npm install tour-guide-live
+```
+
+## Usage
+
+Wrap your app with `TourProvider` and include `TourTooltip`:
+
+```tsx
+import { TourProvider, TourTooltip } from 'tour-guide-live';
+
+function App() {
+  return (
+    <TourProvider
+      apiKey="tgl_your_api_key"
+      userId="user-123"
+      apiBaseUrl="https://your-dashboard.herokuapp.com"
+      userAttributes={{ plan: 'pro' }}
+    >
+      <TourTooltip />
+      <YourApp />
+    </TourProvider>
+  );
+}
+```
+
+### Props
+
+| Prop | Type | Required | Description |
+|------|------|----------|-------------|
+| `apiKey` | `string` | Yes | Your Tour Guide Live API key |
+| `userId` | `string` | Yes | Unique identifier for the current user |
+| `apiBaseUrl` | `string` | No | Dashboard URL (defaults to localhost:3000) |
+| `userAttributes` | `Record<string, unknown>` | No | User attributes for tour targeting |
+
+### Hooks
+
+```tsx
+import { useTour } from 'tour-guide-live';
+
+function MyComponent() {
+  const { startTour, endTour, currentStep } = useTour();
+  // ...
+}
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,67 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React$1 from 'react';
+
+type Tour = {
+    id: string;
+    name: string;
+    status: 'draft' | 'active';
+    steps: Step[];
+    targeting: TargetingRules;
+    createdAt: string;
+};
+type Step = {
+    id: string;
+    title: string;
+    body: string;
+    target: string;
+    placement: 'top' | 'bottom' | 'left' | 'right';
+    spotlight: boolean;
+    completionTrigger: 'next-button' | 'element-click' | 'url-change' | 'manual';
+    urlTrigger?: string;
+    imageUrl?: string;
+};
+type TargetingRules = {
+    urlPattern?: string;
+    conditions: AttributeCondition[];
+    trigger: 'on-page-load' | 'on-element-click';
+    triggerSelector?: string;
+    frequency: 'once' | 'until-complete' | 'every-session';
+};
+type AttributeCondition = {
+    key: string;
+    op: '==' | '!=' | '>' | '<' | '>=' | '<=';
+    value: string | number | boolean;
+};
+type UserProgress = {
+    userId: string;
+    tourId: string;
+    completedSteps: number[];
+    skipped: boolean;
+    completedAt: string | null;
+};
+type TourProviderProps = {
+    apiKey: string;
+    userId: string;
+    userAttributes?: Record<string, unknown>;
+    apiBaseUrl?: string;
+    children: React.ReactNode;
+};
+type TourContextValue = {
+    startTour: (tourId: string) => void;
+    endTour: () => void;
+    goToStep: (stepIndex: number) => void;
+    completeStep: () => void;
+    skipTour: () => void;
+    currentStep: Step | null;
+    currentStepIndex: number;
+    activeTourId: string | null;
+    activeTour: Tour | null;
+    isActive: boolean;
+};
+
+declare function TourProvider({ apiKey, userId, userAttributes, apiBaseUrl, children, }: TourProviderProps): react_jsx_runtime.JSX.Element;
+declare function useTour(): TourContextValue;
+
+declare function TourTooltip(): React$1.ReactPortal | null;
+
+export { type AttributeCondition, type Step, type TargetingRules, type Tour, type TourContextValue, TourProvider, type TourProviderProps, TourTooltip, type UserProgress, useTour };

package/dist/index.d.ts

@@ -0,0 +1,67 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React$1 from 'react';
+
+type Tour = {
+    id: string;
+    name: string;
+    status: 'draft' | 'active';
+    steps: Step[];
+    targeting: TargetingRules;
+    createdAt: string;
+};
+type Step = {
+    id: string;
+    title: string;
+    body: string;
+    target: string;
+    placement: 'top' | 'bottom' | 'left' | 'right';
+    spotlight: boolean;
+    completionTrigger: 'next-button' | 'element-click' | 'url-change' | 'manual';
+    urlTrigger?: string;
+    imageUrl?: string;
+};
+type TargetingRules = {
+    urlPattern?: string;
+    conditions: AttributeCondition[];
+    trigger: 'on-page-load' | 'on-element-click';
+    triggerSelector?: string;
+    frequency: 'once' | 'until-complete' | 'every-session';
+};
+type AttributeCondition = {
+    key: string;
+    op: '==' | '!=' | '>' | '<' | '>=' | '<=';
+    value: string | number | boolean;
+};
+type UserProgress = {
+    userId: string;
+    tourId: string;
+    completedSteps: number[];
+    skipped: boolean;
+    completedAt: string | null;
+};
+type TourProviderProps = {
+    apiKey: string;
+    userId: string;
+    userAttributes?: Record<string, unknown>;
+    apiBaseUrl?: string;
+    children: React.ReactNode;
+};
+type TourContextValue = {
+    startTour: (tourId: string) => void;
+    endTour: () => void;
+    goToStep: (stepIndex: number) => void;
+    completeStep: () => void;
+    skipTour: () => void;
+    currentStep: Step | null;
+    currentStepIndex: number;
+    activeTourId: string | null;
+    activeTour: Tour | null;
+    isActive: boolean;
+};
+
+declare function TourProvider({ apiKey, userId, userAttributes, apiBaseUrl, children, }: TourProviderProps): react_jsx_runtime.JSX.Element;
+declare function useTour(): TourContextValue;
+
+declare function TourTooltip(): React$1.ReactPortal | null;
+
+export { type AttributeCondition, type Step, type TargetingRules, type Tour, type TourContextValue, TourProvider, type TourProviderProps, TourTooltip, type UserProgress, useTour };