@safercity/sdk-react 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,571 @@
+import { SaferCityClientOptions, SaferCityClient, ApiResponse, SaferCityApiError, ServerSentEvent } from '@safercity/sdk';
+export * from '@safercity/sdk';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { QueryClient, UseQueryOptions, UseMutationOptions } from '@tanstack/react-query';
+
+/**
+ * Context value for SaferCity provider
+ */
+interface SaferCityContextValue {
+    client: SaferCityClient;
+}
+/**
+ * Props for SaferCityProvider
+ */
+interface SaferCityProviderProps extends SaferCityClientOptions {
+    children: ReactNode;
+    /**
+     * Custom QueryClient instance (optional)
+     * If not provided, a new QueryClient will be created
+     */
+    queryClient?: QueryClient;
+}
+/**
+ * Provider component for SaferCity SDK
+ *
+ * Wraps your app with the SaferCity client context and TanStack Query provider.
+ *
+ * @example
+ * ```tsx
+ * import { SaferCityProvider } from '@safercity/sdk-react';
+ *
+ * function App() {
+ *   return (
+ *     <SaferCityProvider
+ *       baseUrl="https://api.safercity.com"
+ *       token={userToken}
+ *       tenantId="tenant-123"
+ *     >
+ *       <YourApp />
+ *     </SaferCityProvider>
+ *   );
+ * }
+ * ```
+ */
+declare function SaferCityProvider({ children, queryClient: externalQueryClient, ...clientOptions }: SaferCityProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access the SaferCity client
+ *
+ * Must be used within a SaferCityProvider.
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const { client } = useSaferCity();
+ *
+ *   const handleClick = async () => {
+ *     const { data } = await client.health.check();
+ *     console.log(data);
+ *   };
+ * }
+ * ```
+ */
+declare function useSaferCity(): SaferCityContextValue;
+/**
+ * Hook to access just the SaferCity client
+ *
+ * Convenience wrapper around useSaferCity().
+ */
+declare function useSaferCityClient(): SaferCityClient;
+
+declare const saferCityKeys: {
+    all: readonly ["safercity"];
+    health: () => readonly ["safercity", "health"];
+    auth: () => readonly ["safercity", "auth"];
+    authWhoami: () => readonly ["safercity", "auth", "whoami"];
+    users: () => readonly ["safercity", "users"];
+    usersList: (filters?: Record<string, unknown>) => readonly ["safercity", "users", "list", Record<string, unknown> | undefined];
+    usersDetail: (userId: string) => readonly ["safercity", "users", "detail", string];
+    panics: () => readonly ["safercity", "panics"];
+    panicsList: (filters?: Record<string, unknown>) => readonly ["safercity", "panics", "list", Record<string, unknown> | undefined];
+    panicsDetail: (panicId: string) => readonly ["safercity", "panics", "detail", string];
+    subscriptions: () => readonly ["safercity", "subscriptions"];
+    subscriptionsList: (filters?: Record<string, unknown>) => readonly ["safercity", "subscriptions", "list", Record<string, unknown> | undefined];
+    subscriptionsTypes: () => readonly ["safercity", "subscriptions", "types"];
+    subscriptionsStats: () => readonly ["safercity", "subscriptions", "stats"];
+    locationSafety: (lat: number, lng: number) => readonly ["safercity", "location-safety", number, number];
+    crimes: () => readonly ["safercity", "crimes"];
+    crimesList: (filters?: Record<string, unknown>) => readonly ["safercity", "crimes", "list", Record<string, unknown> | undefined];
+    crimesCategories: () => readonly ["safercity", "crimes", "categories"];
+    crimesTypes: () => readonly ["safercity", "crimes", "types"];
+};
+declare function useHealthCheck(options?: Omit<UseQueryOptions<ApiResponse<{
+    status: string;
+    timestamp: string;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    status: string;
+    timestamp: string;
+}>, SaferCityApiError>;
+declare function useWhoAmI(options?: Omit<UseQueryOptions<ApiResponse<{
+    tenantId: string | null;
+    environment: string;
+    scopes: string[];
+    sessionId: string;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    tenantId: string | null;
+    environment: string;
+    scopes: string[];
+    sessionId: string;
+}>, SaferCityApiError>;
+declare function useUsers(filters?: {
+    limit?: number;
+    cursor?: string;
+    status?: string;
+}, options?: Omit<UseQueryOptions<ApiResponse<{
+    users: Array<{
+        id: string;
+        email?: string;
+        phone?: string;
+        status: string;
+    }>;
+    hasNext: boolean;
+    cursor?: string;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    users: Array<{
+        id: string;
+        email?: string;
+        phone?: string;
+        status: string;
+    }>;
+    hasNext: boolean;
+    cursor?: string;
+}>, SaferCityApiError>;
+declare function useUser(userId: string, options?: Omit<UseQueryOptions<ApiResponse<{
+    id: string;
+    email?: string;
+    phone?: string;
+    firstName?: string;
+    lastName?: string;
+    status: string;
+    metadata?: Record<string, unknown>;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    id: string;
+    email?: string;
+    phone?: string;
+    firstName?: string;
+    lastName?: string;
+    status: string;
+    metadata?: Record<string, unknown>;
+}>, SaferCityApiError>;
+declare function useCreateUser(options?: UseMutationOptions<ApiResponse<{
+    id: string;
+    email?: string;
+    phone?: string;
+}>, SaferCityApiError, {
+    email?: string;
+    phone?: string;
+    firstName?: string;
+    lastName?: string;
+    metadata?: Record<string, unknown>;
+}>): _tanstack_react_query.UseMutationResult<ApiResponse<{
+    id: string;
+    email?: string;
+    phone?: string;
+}>, SaferCityApiError, {
+    email?: string;
+    phone?: string;
+    firstName?: string;
+    lastName?: string;
+    metadata?: Record<string, unknown>;
+}, unknown>;
+declare function useUpdateUser(options?: UseMutationOptions<ApiResponse<{
+    id: string;
+}>, SaferCityApiError, {
+    userId: string;
+    data: {
+        email?: string;
+        phone?: string;
+        firstName?: string;
+        lastName?: string;
+        metadata?: Record<string, unknown>;
+    };
+}>): _tanstack_react_query.UseMutationResult<ApiResponse<{
+    id: string;
+}>, SaferCityApiError, {
+    userId: string;
+    data: {
+        email?: string;
+        phone?: string;
+        firstName?: string;
+        lastName?: string;
+        metadata?: Record<string, unknown>;
+    };
+}, unknown>;
+declare function useDeleteUser(options?: UseMutationOptions<ApiResponse<{
+    success: boolean;
+}>, SaferCityApiError, string>): _tanstack_react_query.UseMutationResult<ApiResponse<{
+    success: boolean;
+}>, SaferCityApiError, string, unknown>;
+declare function usePanics(filters?: {
+    userId?: string;
+    status?: string;
+    limit?: number;
+    cursor?: string;
+}, options?: Omit<UseQueryOptions<ApiResponse<{
+    panics: Array<{
+        id: string;
+        userId: string;
+        status: string;
+        createdAt: string;
+    }>;
+    hasNext: boolean;
+    cursor?: string;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    panics: Array<{
+        id: string;
+        userId: string;
+        status: string;
+        createdAt: string;
+    }>;
+    hasNext: boolean;
+    cursor?: string;
+}>, SaferCityApiError>;
+declare function usePanic(panicId: string, query?: {
+    userId?: string;
+}, options?: Omit<UseQueryOptions<ApiResponse<{
+    id: string;
+    userId: string;
+    status: string;
+    latitude: number;
+    longitude: number;
+    createdAt: string;
+    updatedAt?: string;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    id: string;
+    userId: string;
+    status: string;
+    latitude: number;
+    longitude: number;
+    createdAt: string;
+    updatedAt?: string;
+}>, SaferCityApiError>;
+declare function useCreatePanic(options?: UseMutationOptions<ApiResponse<{
+    id: string;
+    status: string;
+    createdAt: string;
+}>, SaferCityApiError, {
+    userId: string;
+    panicTypeId?: string;
+    latitude: number;
+    longitude: number;
+    accuracy?: number;
+    metadata?: Record<string, unknown>;
+}>): _tanstack_react_query.UseMutationResult<ApiResponse<{
+    id: string;
+    status: string;
+    createdAt: string;
+}>, SaferCityApiError, {
+    userId: string;
+    panicTypeId?: string;
+    latitude: number;
+    longitude: number;
+    accuracy?: number;
+    metadata?: Record<string, unknown>;
+}, unknown>;
+declare function useUpdatePanicLocation(options?: UseMutationOptions<ApiResponse<{
+    id: string;
+    latitude: number;
+    longitude: number;
+}>, SaferCityApiError, {
+    panicId: string;
+    data: {
+        userId: string;
+        latitude: number;
+        longitude: number;
+        accuracy?: number;
+    };
+}>): _tanstack_react_query.UseMutationResult<ApiResponse<{
+    id: string;
+    latitude: number;
+    longitude: number;
+}>, SaferCityApiError, {
+    panicId: string;
+    data: {
+        userId: string;
+        latitude: number;
+        longitude: number;
+        accuracy?: number;
+    };
+}, unknown>;
+declare function useCancelPanic(options?: UseMutationOptions<ApiResponse<{
+    id: string;
+    status: string;
+    cancelledAt: string;
+}>, SaferCityApiError, {
+    panicId: string;
+    data: {
+        userId: string;
+        reason?: string;
+    };
+}>): _tanstack_react_query.UseMutationResult<ApiResponse<{
+    id: string;
+    status: string;
+    cancelledAt: string;
+}>, SaferCityApiError, {
+    panicId: string;
+    data: {
+        userId: string;
+        reason?: string;
+    };
+}, unknown>;
+declare function useSubscriptionTypes(options?: Omit<UseQueryOptions<ApiResponse<{
+    types: Array<{
+        id: string;
+        name: string;
+        description?: string;
+        price?: number;
+    }>;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    types: Array<{
+        id: string;
+        name: string;
+        description?: string;
+        price?: number;
+    }>;
+}>, SaferCityApiError>;
+declare function useSubscriptions(filters?: {
+    userId?: string;
+    status?: string;
+    limit?: number;
+}, options?: Omit<UseQueryOptions<ApiResponse<{
+    subscriptions: Array<{
+        id: string;
+        userId: string;
+        subscriptionTypeId: string;
+        status: string;
+    }>;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    subscriptions: Array<{
+        id: string;
+        userId: string;
+        subscriptionTypeId: string;
+        status: string;
+    }>;
+}>, SaferCityApiError>;
+declare function useSubscriptionStats(options?: Omit<UseQueryOptions<ApiResponse<{
+    total: number;
+    active: number;
+    byType: Record<string, number>;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    total: number;
+    active: number;
+    byType: Record<string, number>;
+}>, SaferCityApiError>;
+declare function useCreateSubscription(options?: UseMutationOptions<ApiResponse<{
+    id: string;
+    userId: string;
+    subscriptionTypeId: string;
+    status: string;
+}>, SaferCityApiError, {
+    userId: string;
+    subscriptionTypeId: string;
+    status?: string;
+}>): _tanstack_react_query.UseMutationResult<ApiResponse<{
+    id: string;
+    userId: string;
+    subscriptionTypeId: string;
+    status: string;
+}>, SaferCityApiError, {
+    userId: string;
+    subscriptionTypeId: string;
+    status?: string;
+}, unknown>;
+declare function useLocationSafety(latitude: number, longitude: number, radius?: number, options?: Omit<UseQueryOptions<ApiResponse<{
+    safetyScore: number;
+    riskLevel: string;
+    factors: Array<{
+        type: string;
+        impact: number;
+    }>;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    safetyScore: number;
+    riskLevel: string;
+    factors: Array<{
+        type: string;
+        impact: number;
+    }>;
+}>, SaferCityApiError>;
+declare function useCrimes(filters?: {
+    latitude?: number;
+    longitude?: number;
+    radius?: number;
+    type?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+}, options?: Omit<UseQueryOptions<ApiResponse<{
+    crimes: Array<{
+        id: string;
+        type: string;
+        latitude: number;
+        longitude: number;
+        occurredAt: string;
+    }>;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    crimes: Array<{
+        id: string;
+        type: string;
+        latitude: number;
+        longitude: number;
+        occurredAt: string;
+    }>;
+}>, SaferCityApiError>;
+declare function useCrimeCategories(options?: Omit<UseQueryOptions<ApiResponse<{
+    categories: Array<{
+        id: string;
+        name: string;
+    }>;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    categories: Array<{
+        id: string;
+        name: string;
+    }>;
+}>, SaferCityApiError>;
+declare function useCrimeTypes(options?: Omit<UseQueryOptions<ApiResponse<{
+    types: Array<{
+        id: string;
+        name: string;
+        categoryId: string;
+    }>;
+}>, SaferCityApiError>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ApiResponse<{
+    types: Array<{
+        id: string;
+        name: string;
+        categoryId: string;
+    }>;
+}>, SaferCityApiError>;
+
+/**
+ * State for streaming hooks
+ */
+interface StreamState<T = ServerSentEvent> {
+    /**
+     * Latest event received
+     */
+    data: T | null;
+    /**
+     * All events received (if keepHistory is true)
+     */
+    events: T[];
+    /**
+     * Whether the stream is currently connected
+     */
+    isConnected: boolean;
+    /**
+     * Whether the stream is connecting
+     */
+    isConnecting: boolean;
+    /**
+     * Error if connection failed
+     */
+    error: Error | null;
+}
+interface UseStreamOptions<T = ServerSentEvent> {
+    /**
+     * Whether to automatically connect on mount
+     * @default true
+     */
+    autoConnect?: boolean;
+    /**
+     * Keep history of all events
+     * @default false
+     */
+    keepHistory?: boolean;
+    /**
+     * Maximum number of events to keep in history
+     * @default 100
+     */
+    maxHistory?: number;
+    /**
+     * Transform raw SSE event to custom type
+     */
+    transform?: (event: ServerSentEvent) => T;
+    /**
+     * Callback when connected
+     */
+    onOpen?: () => void;
+    /**
+     * Callback on each event
+     */
+    onEvent?: (event: T) => void;
+    /**
+     * Callback on error
+     */
+    onError?: (error: Error) => void;
+    /**
+     * Callback when disconnected
+     */
+    onClose?: () => void;
+}
+/**
+ * Hook for streaming panic updates
+ *
+ * @example
+ * ```tsx
+ * function PanicTracker({ panicId }: { panicId: string }) {
+ *   const { data, isConnected, error } = usePanicStream(panicId, {
+ *     onEvent: (event) => console.log('Update:', event),
+ *   });
+ *
+ *   if (error) return <div>Error: {error.message}</div>;
+ *   if (!isConnected) return <div>Connecting...</div>;
+ *
+ *   return <div>Latest: {data?.data}</div>;
+ * }
+ * ```
+ */
+declare function usePanicStream<T = ServerSentEvent>(panicId: string | null | undefined, options?: UseStreamOptions<T>): {
+    connect: () => Promise<void>;
+    disconnect: () => void;
+    /**
+     * Latest event received
+     */
+    data: T | null;
+    /**
+     * All events received (if keepHistory is true)
+     */
+    events: T[];
+    /**
+     * Whether the stream is currently connected
+     */
+    isConnected: boolean;
+    /**
+     * Whether the stream is connecting
+     */
+    isConnecting: boolean;
+    /**
+     * Error if connection failed
+     */
+    error: Error | null;
+};
+/**
+ * Generic hook for any SSE stream
+ */
+declare function useStream<T = ServerSentEvent>(createStream: () => AsyncIterable<ServerSentEvent>, options?: UseStreamOptions<T>): {
+    connect: () => Promise<void>;
+    disconnect: () => void;
+    /**
+     * Latest event received
+     */
+    data: T | null;
+    /**
+     * All events received (if keepHistory is true)
+     */
+    events: T[];
+    /**
+     * Whether the stream is currently connected
+     */
+    isConnected: boolean;
+    /**
+     * Whether the stream is connecting
+     */
+    isConnecting: boolean;
+    /**
+     * Error if connection failed
+     */
+    error: Error | null;
+};
+
+export { SaferCityProvider, type SaferCityProviderProps, type StreamState, type UseStreamOptions, saferCityKeys, useCancelPanic, useCreatePanic, useCreateSubscription, useCreateUser, useCrimeCategories, useCrimeTypes, useCrimes, useDeleteUser, useHealthCheck, useLocationSafety, usePanic, usePanicStream, usePanics, useSaferCity, useSaferCityClient, useStream, useSubscriptionStats, useSubscriptionTypes, useSubscriptions, useUpdatePanicLocation, useUpdateUser, useUser, useUsers, useWhoAmI };