c15t/dist/client/client-interface.d.ts

<div align="center"> <img src="https://c15t.com/logo-icon.png" alt="c15t Logo" width="64" height="64" /> <h1>c15t</h1> <p>Transform privacy consent from a compliance checkbox into a fully observable system</p>

/**
 * Core client interface for consent management.
 * This interface defines the methods that any consent client must implement.
 */
import type { ContractsInputs, ContractsOutputs } from '@c15t/backend';
import type { FetchOptions, ResponseContext } from './types';
export type SetConsentRequestBody = ContractsInputs['consent']['post'];
export type SetConsentResponse = ContractsOutputs['consent']['post'];
export type ShowConsentBannerResponse = ContractsOutputs['consent']['showBanner'];
export type VerifyConsentRequestBody = ContractsInputs['consent']['verify'];
export type VerifyConsentResponse = ContractsOutputs['consent']['verify'];
/**
 * Core interface that all consent management clients must implement
 *
 * @remarks
 * This interface defines the standard methods for interacting with
 * consent management functionality, regardless of implementation.
 */
export interface ConsentManagerInterface {
    /**
     * Checks if a consent banner should be shown.
     *
     * @param options - Optional request configuration
     * @returns Response with information about whether to show the consent banner
     */
    showConsentBanner(options?: FetchOptions<ShowConsentBannerResponse>): Promise<ResponseContext<ShowConsentBannerResponse>>;
    /**
     * Sets consent preferences for a subject.
     *
     * @param options - Optional request configuration with consent data
     * @returns Response confirming consent preferences were set
     */
    setConsent(options?: FetchOptions<SetConsentResponse, SetConsentRequestBody>): Promise<ResponseContext<SetConsentResponse>>;
    /**
     * Verifies if valid consent exists.
     *
     * @param options - Optional request configuration with verification criteria
     * @returns Response with consent verification status
     */
    verifyConsent(options?: FetchOptions<VerifyConsentResponse, VerifyConsentRequestBody>): Promise<ResponseContext<VerifyConsentResponse>>;
    /**
     * Makes a custom API request to any endpoint.
     *
     * @param path - The API endpoint path
     * @param options - Optional request configuration
     * @returns Response from the custom endpoint
     */
    $fetch<ResponseType, BodyType = unknown, QueryType = unknown>(path: string, options?: FetchOptions<ResponseType, BodyType, QueryType>): Promise<ResponseContext<ResponseType>>;
    /**
     * Returns the client's configured callbacks.
     *
     * @returns The callbacks object or undefined if no callbacks are configured
     */
    getCallbacks(): ConsentManagerCallbacks | undefined;
    /**
     * Sets the client's configured callbacks.
     *
     * @param callbacks - The new callbacks object
     */
    setCallbacks(callbacks: ConsentManagerCallbacks): void;
}
/**
 * Payload for the onConsentSet callback
 */
export interface ConsentSetCallbackPayload {
    type: string;
    preferences: Record<string, boolean>;
    domain?: string;
}
/**
 * Payload for the onConsentBannerFetched callback
 */
export interface ConsentBannerFetchedCallbackPayload {
    showConsentBanner: boolean;
    jurisdiction: {
        code: string;
        message: string;
    };
    location?: {
        countryCode: string | null;
        regionCode: string | null;
    };
}
/**
 * Payload for the onConsentVerified callback
 */
export interface ConsentVerifiedCallbackPayload {
    type: string;
    domain?: string;
    preferences: string[];
    valid: boolean;
}
/**
 * Base callback configuration for consent clients
 */
export interface ConsentManagerCallbacks {
    /**
     * Called when an API request fails.
     * @param response - The full response context with error information
     * @param path - The API endpoint path that was requested
     */
    onError?: (response: ResponseContext<unknown>, path: string) => void;
    /**
     * Called after successfully fetching the consent banner information
     * @param response The response from the showConsentBanner endpoint
     */
    onConsentBannerFetched?: (response: ResponseContext<ConsentBannerFetchedCallbackPayload>) => void;
    /**
     * Called after successfully setting consent preferences
     * @param response The response from the setConsent endpoint
     */
    onConsentSet?: (response: ResponseContext<ConsentSetCallbackPayload>) => void;
    /**
     * Called after successfully verifying consent
     * @param response The response from the verifyConsent endpoint
     */
    onConsentVerified?: (response: ResponseContext<ConsentVerifiedCallbackPayload>) => void;
}
//# sourceMappingURL=client-interface.d.ts.map