@bookinglab/booking-journey-api 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 BookingLab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,178 @@
+# @bookinglab/booking-journey-api
+
+A lightweight, developer-friendly TypeScript library for BookingLab and JRNI APIs. Supports both vanilla JavaScript/TypeScript and React applications.
+
+## Features
+
+- 🎯 **Type-safe** - Full TypeScript support with comprehensive type definitions
+- ⚛️ **React-ready** - Context providers and hooks for seamless React integration
+- 🌳 **Tree-shakable** - Only bundle what you use
+- 🔧 **Flexible** - Works with vanilla JS/TS or React
+- 📦 **Lightweight** - Minimal dependencies
+
+## Installation
+
+```bash
+npm install @bookinglab/booking-journey-api
+```
+
+For React applications, you'll also need:
+
+```bash
+npm install @tanstack/react-query
+```
+
+## Quick Start
+
+### Vanilla JavaScript/TypeScript
+
+```typescript
+import { createJrniClient } from '@bookinglab/booking-journey-api';
+
+const client = createJrniClient('https://api.jrni.com', {
+  appId: 'your-app-id',
+  appKey: 'your-app-key',
+});
+
+// Login
+const response = await client.login({
+  email: 'user@example.com',
+  password: 'password',
+});
+
+console.log(response.data.auth_token);
+```
+
+### React Applications
+
+```tsx
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+import { JrniProvider, useLogin } from '@bookinglab/booking-journey-api';
+
+const queryClient = new QueryClient();
+
+function App() {
+  return (
+    <QueryClientProvider client={queryClient}>
+      <JrniProvider
+        baseUrl="https://api.jrni.com"
+        config={{ appId: 'your-app-id', appKey: 'your-app-key' }}
+      >
+        <LoginForm />
+      </JrniProvider>
+    </QueryClientProvider>
+  );
+}
+
+function LoginForm() {
+  const loginMutation = useLogin();
+
+  const handleLogin = () => {
+    loginMutation.mutate({
+      email: 'user@example.com',
+      password: 'password',
+    });
+  };
+
+  return (
+    <button onClick={handleLogin} disabled={loginMutation.isPending}>
+      {loginMutation.isPending ? 'Logging in...' : 'Login'}
+    </button>
+  );
+}
+```
+
+## API Reference
+
+### Core Client
+
+#### `createJrniClient(baseUrl, config)`
+
+Creates a new JRNI client instance.
+
+```typescript
+const client = createJrniClient('https://api.jrni.com', {
+  appId: 'your-app-id',
+  appKey: 'your-app-key',
+});
+```
+
+#### Client Methods
+
+- `client.login(credentials)` - Authenticate a user
+
+### React Providers
+
+#### `JrniProvider`
+
+Provides JRNI client context to React components.
+
+```tsx
+<JrniProvider
+  baseUrl="https://api.jrni.com"
+  config={{ appId: 'your-app-id', appKey: 'your-app-key' }}
+>
+  {children}
+</JrniProvider>
+```
+
+#### `ApiClientProvider`
+
+Combined provider for applications using multiple API clients.
+
+```tsx
+<ApiClientProvider
+  jrniBaseUrl="https://api.jrni.com"
+  jrniConfig={{ appId: 'your-app-id', appKey: 'your-app-key' }}
+>
+  {children}
+</ApiClientProvider>
+```
+
+### React Hooks
+
+#### `useLogin()`
+
+Hook for user authentication.
+
+```typescript
+const { mutate, isPending, isError, data } = useLogin();
+
+mutate({ email: 'user@example.com', password: 'password' });
+```
+
+#### `useJrniClient()`
+
+Access the JRNI client directly for custom operations.
+
+```typescript
+const client = useJrniClient();
+const response = await client.login(credentials);
+```
+
+## Types
+
+The library exports comprehensive TypeScript types:
+
+```typescript
+import type {
+  LoginRequest,
+  LoginResponse,
+  JrniService,
+  ServicesResponse,
+  Question,
+  QuestionsResponse,
+  Location,
+  LocationsResponse,
+  Vehicle,
+  VehiclesResponse,
+  JrniBooking,
+  MemberBookingsResponse,
+  AvailabilityTime,
+  AvailabilityTimesResponse,
+} from '@bookinglab/booking-journey-api';
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,404 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import * as _tanstack_react_query from '@tanstack/react-query';
+
+/**
+ * Core API Client Types
+ */
+interface ApiClientConfig {
+    baseUrl: string;
+    headers?: Record<string, string>;
+    timeout?: number;
+}
+interface RequestOptions extends RequestInit {
+    params?: Record<string, string | number | boolean | undefined>;
+}
+interface ApiResponse<T = any> {
+    data: T;
+    status: number;
+    headers: Headers;
+}
+interface ApiError {
+    message: string;
+    status?: number;
+    code?: string;
+    details?: any;
+}
+/**
+ * JRNI Configuration
+ */
+interface JrniConfig {
+    appId: string;
+    appKey: string;
+}
+/**
+ * JRNI API Types
+ */
+interface LoginRequest {
+    email: string;
+    password: string;
+}
+interface LoginResponse {
+    email: string;
+    auth_token: string;
+    company_id: number;
+    path: string;
+    role?: string;
+    _embedded?: {
+        members?: Array<{
+            id: number;
+            name: string;
+            first_name: string;
+            last_name: string;
+            email: string;
+            [key: string]: any;
+        }>;
+        administrators?: any[];
+    };
+    _links?: any;
+}
+interface JrniService {
+    id: number;
+    name: string;
+    description: string;
+    durations: number[];
+    prices: number[];
+    detail_group_id: number;
+    listed_durations: any[];
+    extra: Record<string, any>;
+    booking_time_step: number;
+    can_refund_automatically: boolean;
+    is_event_group: boolean;
+    type: string;
+    group_id: number | null;
+    deleted: boolean;
+    queuing_disabled: boolean;
+    company_id: number;
+    min_advance_period: number;
+    max_advance_period: number;
+    min_cancel_period: number;
+    booking_type_public: string;
+    booking_type: number;
+    mbooking_type: number;
+    min_bookings: number;
+    max_bookings: number;
+    method_of_appointment: string;
+    groups: any[];
+    order: number;
+    child_level_service: boolean;
+    global_id: number;
+    availability: number;
+    prices_in_major_units: number[];
+    combine_resource_and_staff: boolean;
+    disabled: boolean;
+    _links: Record<string, any>;
+}
+interface ServicesResponse {
+    total_entries: number;
+    _embedded: {
+        services: JrniService[];
+    };
+    _links: Record<string, any>;
+}
+interface QuestionOption {
+    name: string;
+    price: number;
+    is_default: boolean;
+    id: number;
+}
+interface Question {
+    id: number;
+    name: string;
+    required: boolean;
+    important: boolean;
+    admin_only: boolean;
+    applies_to: number;
+    ask_member: boolean;
+    detail_type: string;
+    options?: QuestionOption[];
+    settings: Record<string, any>;
+    price: number;
+    price_per_booking: boolean;
+    outcome: boolean;
+    hide_on_customer_journey: boolean;
+    default?: string;
+    help_text?: string;
+    _links: Record<string, any>;
+}
+interface QuestionsResponse {
+    company_id: number;
+    questions: Question[];
+    name: string;
+    _links: Record<string, any>;
+}
+interface Location {
+    id: number;
+    name: string;
+    description: string;
+    company_type: string;
+    address: {
+        id: number;
+        address1: string;
+        address2: string;
+        address3: string;
+        address4: string;
+        address5: string;
+        postcode: string;
+        country: string;
+    };
+}
+interface LocationsResponse {
+    total_entries: number;
+    _embedded: {
+        resources: Location[];
+    };
+    _links: Record<string, any>;
+}
+interface Vehicle {
+    id: number;
+    name: string;
+    description: string;
+    type: string;
+    extra: {
+        vehicle_registration?: string;
+        vehicle_make?: string;
+        vehicle_model?: string;
+        vehicle_size?: string;
+        fuel_type?: string;
+        vehicle_brand?: string;
+        vehicle_transmission?: string;
+        base_location?: string;
+        driver_name?: string;
+        driver_email?: string;
+    };
+    group_id: number | null;
+    deleted: boolean;
+    disabled: boolean;
+    company_id: number;
+    order: number;
+    created_at: string;
+    updated_at: string;
+    _links: Record<string, any>;
+}
+interface VehiclesResponse {
+    total_entries: number;
+    _embedded: {
+        people: Vehicle[];
+    };
+    _links: Record<string, any>;
+}
+interface AddBasketItemRequest {
+    service_id: number;
+    start: string;
+    duration: number;
+    company_id: string;
+    person_id: number;
+    questions: Array<{
+        id: string;
+        answer: string;
+    }>;
+}
+interface AvailabilityTime {
+    start: string;
+    available: boolean;
+    durations: number[];
+    prices: number[];
+    _links: Record<string, any>;
+}
+interface AvailabilityTimesResponse {
+    times: AvailabilityTime[];
+}
+interface JrniBooking {
+    id: number;
+    full_describe: string;
+    describe: string;
+    person_name: string;
+    datetime: string;
+    end_datetime: string;
+    duration: number;
+    service_name: string;
+    service_id: number;
+    status: string;
+    is_cancelled: boolean;
+    min_cancellation_time?: number;
+    person_ids?: number[];
+    settings?: {
+        current_multi_stat?: string;
+        multi_stats?: Record<string, string>;
+        obfuscated_id?: string;
+        who_updated?: string;
+    };
+    questions: Record<string, {
+        answer: string;
+        answer_id: number | null;
+        name: string;
+    }>;
+    _embedded?: {
+        answers?: Array<{
+            id: number;
+            value: string;
+            question_text: string;
+        }>;
+    };
+}
+interface MemberBookingsResponse {
+    total_entries: number;
+    _embedded: {
+        bookings: JrniBooking[];
+    };
+    _links: Record<string, any>;
+}
+interface PersonImage {
+    id: number;
+    name: string;
+    url: string;
+    order: number;
+    person_id?: number;
+}
+interface PersonImagesResponse {
+    _embedded: {
+        images: PersonImage[];
+    };
+    _links: Record<string, any>;
+}
+interface UpdateClientDetailsData {
+    first_name: string;
+    last_name: string;
+    mobile: string;
+    questions?: Record<string, {
+        answer: string;
+    }>;
+}
+interface UpdateMemberDetailsData {
+    first_name: string;
+    last_name: string;
+    mobile?: string;
+    q?: Record<string, {
+        answer: string;
+        answer_id: number;
+        name: string;
+    }>;
+    answers?: Array<{
+        question_id: number;
+        name: string;
+        answer: string;
+        answer_id: number;
+    }>;
+}
+
+/**
+ * Core API Client
+ * Base class for making HTTP requests
+ */
+
+declare class ApiClient {
+    protected baseUrl: string;
+    protected headers: Record<string, string>;
+    protected timeout: number;
+    constructor(config: ApiClientConfig);
+    /**
+     * Update client configuration
+     */
+    setConfig(config: Partial<ApiClientConfig>): void;
+    /**
+     * Set authorization token
+     */
+    setAuthToken(token: string): void;
+    /**
+     * Make an HTTP request
+     */
+    protected request<T>(endpoint: string, options?: RequestOptions): Promise<ApiResponse<T>>;
+    /**
+     * GET request
+     */
+    protected get<T>(endpoint: string, options?: RequestOptions): Promise<ApiResponse<T>>;
+    /**
+     * POST request
+     */
+    protected post<T>(endpoint: string, body?: any, options?: RequestOptions): Promise<ApiResponse<T>>;
+    /**
+     * PUT request
+     */
+    protected put<T>(endpoint: string, body?: any, options?: RequestOptions): Promise<ApiResponse<T>>;
+    /**
+     * DELETE request
+     */
+    protected delete<T>(endpoint: string, options?: RequestOptions): Promise<ApiResponse<T>>;
+    /**
+     * Handle error responses
+     */
+    private handleError;
+    /**
+     * Normalize errors to consistent format
+     */
+    private normalizeError;
+}
+
+/**
+ * JRNI API Client
+ * Provides methods for interacting with the JRNI API
+ */
+
+declare class JrniClient extends ApiClient {
+    private appId;
+    private appKey;
+    constructor(baseUrl: string, config: JrniConfig);
+    /**
+     * Login to JRNI
+     */
+    login(credentials: LoginRequest): Promise<ApiResponse<LoginResponse>>;
+    /**
+     * Update JRNI configuration
+     */
+    setJrniConfig(config: Partial<JrniConfig>): void;
+}
+/**
+ * Create a new JRNI client instance
+ */
+declare function createJrniClient(baseUrl: string, config: JrniConfig): JrniClient;
+
+interface ApiClientContextValue {
+    jrniClient: JrniClient | null;
+}
+interface ApiClientProviderProps {
+    children: ReactNode;
+    jrniBaseUrl?: string;
+    jrniConfig?: JrniConfig;
+}
+/**
+ * Combined provider for multiple API clients
+ */
+declare function ApiClientProvider({ children, jrniBaseUrl, jrniConfig, }: ApiClientProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access API client context
+ */
+declare function useApiClientContext(): ApiClientContextValue;
+
+interface JrniProviderProps {
+    children: ReactNode;
+    baseUrl: string;
+    config: JrniConfig;
+}
+/**
+ * Provider component for JRNI client
+ */
+declare function JrniProvider({ children, baseUrl, config }: JrniProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access JRNI client from context
+ */
+declare function useJrniContext(): JrniClient;
+
+/**
+ * Hook to access API clients from context
+ */
+/**
+ * Hook to get JRNI client from either ApiClientProvider or JrniProvider
+ */
+declare function useJrniClient(): JrniClient;
+
+/**
+ * Hook for JRNI login
+ */
+declare function useLogin(): _tanstack_react_query.UseMutationResult<LoginResponse, Error, LoginRequest, unknown>;
+
+export { type AddBasketItemRequest, ApiClient, type ApiClientConfig, ApiClientProvider, type ApiError, type ApiResponse, type AvailabilityTime, type AvailabilityTimesResponse, type JrniBooking, JrniClient, type JrniConfig, JrniProvider, type JrniService, type Location, type LocationsResponse, type LoginRequest, type LoginResponse, type MemberBookingsResponse, type PersonImage, type PersonImagesResponse, type Question, type QuestionOption, type QuestionsResponse, type RequestOptions, type ServicesResponse, type UpdateClientDetailsData, type UpdateMemberDetailsData, type Vehicle, type VehiclesResponse, createJrniClient, useApiClientContext, useJrniClient, useJrniContext, useLogin };