Utilities API Reference

Utility functions and helpers available in Flowfull Clients.

Authentication Utilities

isAuthenticated

Check if a user is authenticated.

function isAuthenticated(user: User | null): boolean

Example:

import { isAuthenticated } from '@pubflow/react';

const { user } = useAuth();
if (isAuthenticated(user)) {
  console.log('User is authenticated');
}

hasUserType

Check if a user has a specific user type.

function hasUserType(user: User | null, types: string | string[]): boolean

Example:

import { hasUserType } from '@pubflow/react';

const { user } = useAuth();
if (hasUserType(user, ['admin', 'superadmin'])) {
  console.log('User is admin');
}

Storage Utilities

BrowserStorageAdapter

Browser localStorage adapter for React.

class BrowserStorageAdapter implements StorageAdapter {
  constructor(prefix?: string);
  getItem(key: string): Promise<string | null>;
  setItem(key: string, value: string): Promise<void>;
  removeItem(key: string): Promise<void>;
  clear(): Promise<void>;
}

Example:

import { BrowserStorageAdapter } from '@pubflow/react';

const storage = new BrowserStorageAdapter('myapp_');
await storage.setItem('key', 'value');
const value = await storage.getItem('key');

SecureStorageAdapter

Secure storage adapter for React Native (Expo SecureStore with AsyncStorage fallback).

class SecureStorageAdapter implements StorageAdapter {
  constructor(useSecureStorage?: boolean, prefix?: string);
  getItem(key: string): Promise<string | null>;
  setItem(key: string, value: string): Promise<void>;
  removeItem(key: string): Promise<void>;
  clear(): Promise<void>;
}

Example:

import { SecureStorageAdapter } from '@pubflow/react-native';

const storage = new SecureStorageAdapter(true, 'myapp_');
await storage.setItem('session_id', 'abc123');

API Utilities

ApiClient

Low-level HTTP client with automatic authentication.

class ApiClient {
  constructor(config: ApiClientConfig);
  get<T>(path: string, options?: RequestOptions): Promise<T>;
  post<T>(path: string, data?: any, options?: RequestOptions): Promise<T>;
  put<T>(path: string, data?: any, options?: RequestOptions): Promise<T>;
  patch<T>(path: string, data?: any, options?: RequestOptions): Promise<T>;
  delete<T>(path: string, options?: RequestOptions): Promise<T>;
}

Example:

import { ApiClient, BrowserStorageAdapter } from '@pubflow/core';

const client = new ApiClient({
  baseUrl: 'https://api.example.com',
  storage: new BrowserStorageAdapter()
});

const users = await client.get('/api/users');

BridgeApiService

High-level Bridge API service for entity operations.

class BridgeApiService<T extends EntityData> {
  constructor(apiClient: ApiClient, config: EntityConfig);
  getList(params?: QueryParams): Promise<PaginatedResponse<T>>;
  getById(id: string, params?: QueryParams): Promise<T>;
  search(params: SearchParams): Promise<PaginatedResponse<T>>;
  create(data: Partial<T>): Promise<T>;
  update(id: string, data: Partial<T>): Promise<T>;
  delete(id: string): Promise<void>;
}

Example:

import { BridgeApiService, ApiClient } from '@pubflow/core';

const service = new BridgeApiService(apiClient, {
  endpoint: 'users'
});

const users = await service.getList({ page: 1, limit: 20 });

Next.js Utilities

withPubflow

API route middleware for Next.js.

function withPubflow(
  handler: (req, res, api, auth) => Promise<void>,
  instanceId?: string
): (req, res) => Promise<void>

Example:

import { withPubflow } from '@pubflow/nextjs';

export default withPubflow(async (req, res, api, auth) => {
  const users = await api.get('/bridge/users');
  res.json(users);
});

withPubflowAuth

Authenticated API route middleware for Next.js.

function withPubflowAuth(
  handler: (req, res, api, auth, user) => Promise<void>,
  options?: { instanceId?: string; allowedTypes?: string[] }
): (req, res) => Promise<void>

Example:

import { withPubflowAuth } from '@pubflow/nextjs';

export default withPubflowAuth(
  async (req, res, api, auth, user) => {
    res.json({ user });
  },
  { allowedTypes: ['admin'] }
);

withPubflowSSR

SSR helper for Next.js pages.

function withPubflowSSR(
  getServerSideProps: (context, api, auth) => Promise<GetServerSidePropsResult>
): GetServerSideProps

Example:

import { withPubflowSSR } from '@pubflow/nextjs';

export const getServerSideProps = withPubflowSSR(async (context, api, auth) => {
  const users = await api.get('/bridge/users');
  return { props: { users } };
});

Next Steps

• Hooks API - Hooks reference
• Components API - Components reference
• Types API - TypeScript types reference