Flowsery Analytics można zainstalować jako pakiet npm, aby śledzić zdarzenia z bezpieczeństwem typów w projektach JavaScript i TypeScript. Działa z React, Next.js, Vue, Angular i każdym innym frameworkiem webowym.
Dlaczego warto użyć SDK?
- Obsługa TypeScript: pełne definicje typów do autouzupełniania i kontroli podczas kompilacji
- Tree-shaking: import tylko potrzebnych elementów
- Niezależność od frameworka: zgodność z React, Vue, Angular, Svelte, React Native / Expo i czystym JS
- Automatyczne śledzenie: wbudowane zbieranie odsłon, sesji i danych o urządzeniu
- Praca offline: zdarzenia trafiają do kolejki i są wysyłane po odzyskaniu połączenia
Instalacja
npm install flowserySzybki start
Podstawowa konfiguracja
import { initFlowsery } from 'flowsery';
const flowsery = await initFlowsery({
websiteId: 'flid_******',
domain: 'your_domain.com',
});
// Track custom events
flowsery.trackEvent('signup', { email: 'user@example.com' });
// Identify users
flowsery.identify({ userId: 'user_123', email: 'user@example.com', name: 'John Doe' });Przykład React / Next.js
import { initFlowsery } from 'flowsery';
let flowsery: any = null;
export async function getAnalytics() {
if (!flowsery) {
flowsery = await initFlowsery({
websiteId: process.env.NEXT_PUBLIC_FLOWSERY_WEBSITE_ID!,
domain: process.env.NEXT_PUBLIC_FLOWSERY_DOMAIN,
});
}
return flowsery;
}Przykład React Native / Expo
import { FlowseryProvider } from 'flowsery/react-native';
export default function RootLayout() {
return (
<FlowseryProvider
config={{
websiteId: process.env.EXPO_PUBLIC_FLOWSERY_WEBSITE_ID!,
domain: process.env.EXPO_PUBLIC_FLOWSERY_DOMAIN!,
local: __DEV__,
}}>
{/* your navigation / screens here */}
</FlowseryProvider>
);
}Opcje konfiguracji
interface FlowseryConfig {
websiteId: string;
domain?: string;
apiBase?: string;
local?: boolean; // default: false
cookieless?: boolean; // default: false
allowFileProtocol?: boolean; // default: false
allowIframe?: boolean; // default: false
disablePayments?: boolean; // default: false
disableConsole?: boolean; // default: false
allowedHostnames?: string[];
hashMode?: boolean; // default: false
}Metody API
trackEvent
Śledzi własne zdarzenia z opcjonalnymi metadanymi.
flowsery.trackEvent('button_click');
flowsery.trackEvent('purchase', { amount: 99.99, currency: 'USD', product: 'Premium Plan' });trackPayment
Śledzi zdarzenia płatności z kwotą, walutą i metadanymi.
flowsery.trackPayment({ amount: 49, currency: 'USD', email: 'user@example.com' });trackPageview
Ręcznie rejestruje odsłonę.
flowsery.trackPageview();identify
Identyfikuje bieżącego odwiedzającego na podstawie danych użytkownika.
flowsery.identify({ userId: 'user_123', email: 'user@example.com', name: 'John Doe' });stop
Zatrzymuje śledzenie i wysyła zdarzenia z kolejki.
flowsery.stop();reset
Resetuje stan klienta (usuwa dane odwiedzającego i sesji).
flowsery.reset();getVisitorId / getSessionId
Pobiera bieżący identyfikator odwiedzającego lub sesji.
const visitorId = flowsery.getVisitorId();
const sessionId = flowsery.getSessionId();Śledzenie między domenami (SDK)
const params = flowsery.getTrackingParams();
const url = flowsery.buildCrossDomainUrl('https://myapp.io/signup');Struktura pakietu
- flowsery: główny SDK dla aplikacji webowych (adaptery localStorage, fetch)
- flowsery/react-native: implementacja dla React Native / Expo (AsyncStorage, NetInfo, Expo device)
Potrzebna pomoc?
Opcje zaawansowane, takie jak śledzenie na localhost, konfiguracja proxy i śledzenie między domenami, opisuje dokumentacja konfiguracji skryptu.