@axcode/axcloud-sdk 0.2.0-dev.03fb26c → 0.2.0-dev.5dc7e06

package/dist/useBarnsport-C6uDSuHf.d.mts

@@ -0,0 +1,583 @@
+import * as _tanstack_react_query from '@tanstack/react-query';
+
+interface BarnsportMunicipality {
+    id: string;
+    slug: string;
+    name: string;
+    county?: string;
+    geo?: {
+        lat: number;
+        lng: number;
+        bounds?: [number, number, number, number];
+    };
+}
+interface BarnsportSportArticle {
+    short_description?: string;
+    what_is_it?: string;
+    why_fun?: string;
+    good_to_know?: {
+        age?: string;
+        equipment?: string;
+        cost?: string;
+    };
+    fun_facts?: string[];
+}
+interface BarnsportSport {
+    id: string;
+    slug: string;
+    name: string;
+    icon?: string;
+    color?: string;
+    category?: string;
+    is_featured?: boolean;
+    hero_image_url?: string;
+    short_description?: string;
+    /** Present on the single-sport endpoint (GET /public/{orgId}/sports/{slug}). */
+    article?: BarnsportSportArticle;
+}
+interface BarnsportActivitySchedule {
+    weekday?: number;
+    starts_at?: string;
+    ends_at?: string;
+    label?: string;
+    season?: string;
+}
+interface BarnsportActivityLocation {
+    name?: string;
+    address?: string;
+    lat?: number;
+    lng?: number;
+}
+interface BarnsportRegistrationMethod {
+    type: 'url' | 'email' | 'phone' | 'form' | 'external';
+    label?: string;
+    value: string;
+    instructions?: string;
+    preferred?: boolean;
+}
+interface BarnsportActivityListItem {
+    id: string;
+    slug: string;
+    title: string;
+    summary?: string;
+    sport: {
+        id: string;
+        slug: string;
+        name?: string;
+        icon?: string;
+    };
+    municipality: {
+        id: string;
+        slug: string;
+        name?: string;
+    };
+    club: {
+        id: string;
+        slug: string;
+        name?: string;
+    };
+    birthYears?: number[];
+    minBirthYear?: number;
+    maxBirthYear?: number;
+    ageLabel?: string;
+    schedule: BarnsportActivitySchedule[];
+    location?: BarnsportActivityLocation;
+    registrationSummary?: string;
+    updatedAt: string;
+}
+interface BarnsportActivity {
+    activity_id: string;
+    org_id: string;
+    slug: string;
+    title: string;
+    summary?: string;
+    description?: string;
+    sport_id: string;
+    sport_slug: string;
+    sport_name?: string;
+    sport_icon?: string;
+    municipality_id: string;
+    municipality_slug: string;
+    municipality_name?: string;
+    club_id: string;
+    club_slug: string;
+    club_name?: string;
+    club_website_url?: string;
+    birth_years?: number[];
+    min_birth_year?: number;
+    max_birth_year?: number;
+    age_label?: string;
+    schedule: BarnsportActivitySchedule[];
+    location?: BarnsportActivityLocation;
+    registration: {
+        methods: BarnsportRegistrationMethod[];
+        deadline?: string;
+        price_label?: string;
+    };
+    seo?: {
+        title?: string;
+        description?: string;
+        image_media_id?: string;
+    };
+    published_at?: string;
+    updated_at: string;
+}
+interface BarnsportActivitiesFilter {
+    municipality?: string;
+    sport?: string;
+    birthYear?: number;
+    q?: string;
+    search?: string;
+    sort?: 'updated' | 'name' | 'relevance';
+    cursor?: string;
+    limit?: number;
+}
+interface BarnsportListResponse<T> {
+    items: T[];
+    count: number;
+    nextCursor?: string | null;
+}
+interface BarnsportActivityResponse {
+    activity: BarnsportActivity;
+}
+interface BarnsportSitemapUrl {
+    loc: string;
+    lastmod?: string;
+    changefreq?: string;
+    priority?: number;
+}
+interface BarnsportSitemapResponse {
+    baseUrl: string;
+    updatedAt: string;
+    urls: BarnsportSitemapUrl[];
+}
+/**
+ * Backward-compatible, extensible request shape. The API validates the
+ * cross-field requirements for interest and contact-help submissions.
+ */
+interface BarnsportInterestSubmissionRequest {
+    activitySlug?: string;
+    activityOfferSlug?: string;
+    providerSlug?: string;
+    sportSlug?: string;
+    municipalitySlug?: string;
+    requestKind?: 'interest' | 'contact_help';
+    guardianName?: string;
+    guardianEmail: string;
+    guardianPhone?: string;
+    childName?: string;
+    childBirthYear?: number;
+    message?: string;
+    consent: {
+        contact: boolean;
+        privacyVersion: string;
+    };
+    honeypot?: string;
+    source?: {
+        site?: string;
+        pageUrl?: string;
+        utm?: Record<string, string>;
+    };
+}
+type BarnsportInquiryTarget = {
+    activitySlug: string;
+    providerSlug?: string;
+} | {
+    activitySlug?: string;
+    providerSlug: string;
+};
+/**
+ * Opt-in strict request contract. A normal interest inquiry requires guardian
+ * details and the child's birth year. Contact-help is intentionally lighter,
+ * but both variants must identify either an activity or a provider.
+ */
+type BarnsportInquirySubmissionRequest = BarnsportInquiryTarget & BarnsportInterestSubmissionRequest & ({
+    requestKind?: 'interest';
+    guardianName: string;
+    childBirthYear: number;
+} | {
+    requestKind: 'contact_help';
+    guardianName?: string;
+    childBirthYear?: number;
+});
+interface BarnsportInterestSubmissionResponse extends BarnsportInquiryResponse {
+    success: boolean;
+    submissionId?: string;
+    duplicate?: boolean;
+    message: string;
+}
+interface BarnsportProviderUpdateRequest {
+    requesterName: string;
+    requesterEmail: string;
+    requesterRole?: string;
+    proposedChanges: {
+        website_url?: string;
+        description?: string;
+        street_address?: string;
+        postal_code?: string;
+        locality?: string;
+    };
+    message?: string;
+    honeypot?: string;
+    source?: {
+        site?: string;
+        pageUrl?: string;
+    };
+}
+interface BarnsportProviderUpdateResponse {
+    accepted?: boolean;
+    success?: boolean;
+    message?: string;
+    request?: {
+        id?: string;
+        status?: string;
+    };
+}
+interface BarnsportClubRemovalRequest {
+    requesterName: string;
+    requesterEmail: string;
+    requesterRole?: string;
+    requestedAction?: 'hide' | 'delete';
+    reason?: string;
+    honeypot?: string;
+    source?: {
+        site?: string;
+        pageUrl?: string;
+    };
+}
+interface BarnsportClubRemovalResponse {
+    success: boolean;
+    requestId?: string;
+    clubSlug?: string;
+    hiddenActivities?: number;
+    message: string;
+}
+type BarnsportSourceConfidence = 'high' | 'medium' | 'low';
+type BarnsportVerificationStatus = 'needs_verification' | 'verified' | 'rejected' | 'archived';
+type BarnsportYouthStatus = 'confirmed_youth' | 'likely_youth' | 'unknown' | 'unlikely_youth';
+type BarnsportActivityEnvironment = 'indoor' | 'outdoor' | 'mixed' | 'unknown';
+interface BarnsportMunicipalitySummary {
+    id: string;
+    slug: string;
+    name: string;
+    county?: string;
+}
+interface BarnsportSportSummary {
+    id: string;
+    slug: string;
+    name: string;
+    icon?: string;
+    category?: string;
+}
+interface BarnsportProviderSummary {
+    id: string;
+    slug: string;
+    name: string;
+    logo_url?: string;
+    website_url?: string;
+    municipality_slug?: string;
+    municipality_name?: string;
+    primary_sport_slug?: string;
+    primary_sport_name?: string;
+}
+interface BarnsportCourseCandidate {
+    title: string;
+    summary?: string;
+    age_text?: string;
+    schedule_text?: string;
+    price_text?: string;
+    beginner_friendly?: boolean;
+    trial_available?: boolean;
+    low_cost?: boolean;
+    weekend_available?: boolean;
+    environment?: BarnsportActivityEnvironment;
+    signup_url?: string;
+    source_url?: string;
+    source_title?: string;
+    confidence?: BarnsportSourceConfidence;
+    evidence?: string[];
+    review_required?: boolean;
+    review_flags?: string[];
+}
+interface BarnsportActivityOffer {
+    id: string;
+    slug: string;
+    title: string;
+    is_featured?: boolean;
+    source_label?: string;
+    verification_status?: BarnsportVerificationStatus;
+    youth_status?: BarnsportYouthStatus;
+    youth_evidence?: string[];
+    inquiry_contact_status?: 'ready' | 'review_first' | 'needs_contact' | 'do_not_contact';
+    contact_help_supported?: boolean;
+    registration_status?: string;
+    season?: string;
+    registration_window?: string;
+    verified_at?: string;
+    stale_at?: string;
+    is_stale?: boolean;
+    age_text?: string;
+    age_source?: string;
+    age_verification_status?: 'verified_by_provider' | 'found_unverified' | 'missing';
+    birth_year_from?: number;
+    birth_year_to?: number;
+    schedule_text?: string;
+    sessions_text?: string;
+    location_name?: string;
+    location_address?: string;
+    locality?: string;
+    location_lat?: number;
+    location_lng?: number;
+    price_text?: string;
+    beginner_friendly?: boolean;
+    trial_available?: boolean;
+    low_cost?: boolean;
+    weekend_available?: boolean;
+    environment?: BarnsportActivityEnvironment;
+    signup_url?: string;
+    contact_url?: string;
+    source_url?: string;
+    source_last_seen_at?: string;
+    source_confidence?: BarnsportSourceConfidence;
+    missing_fields?: string[];
+    review_required?: boolean;
+    review_flags?: string[];
+    course_candidates?: BarnsportCourseCandidate[];
+    provider?: BarnsportProviderSummary;
+    sport?: BarnsportSportSummary;
+    municipality?: BarnsportMunicipalitySummary;
+}
+interface BarnsportReview {
+    id: string;
+    rating: number;
+    published_text?: string | null;
+    display_name: string;
+    created_at: string;
+}
+interface BarnsportReviewsSummary {
+    count: number;
+    average_rating: number | null;
+    items: BarnsportReview[];
+}
+interface BarnsportStats {
+    interest_count: number | null;
+    view_count: number | null;
+}
+interface BarnsportProvider extends BarnsportProviderSummary {
+    provider_type?: string;
+    description?: string;
+    organization?: string;
+    category_label?: string;
+    logo_path?: string;
+    logo_mime_type?: string;
+    is_verified: boolean;
+    verified_at?: string;
+    source_url?: string;
+    source_register_url?: string;
+    source_last_seen_at?: string;
+    source_confidence?: BarnsportSourceConfidence;
+    geocode_status?: string;
+    address_text?: string;
+    street_address?: string;
+    postal_code?: string;
+    locality?: string;
+    country_code?: string;
+    latitude?: number;
+    longitude?: number;
+    municipality_county?: string;
+    municipality?: BarnsportMunicipalitySummary;
+    sports?: BarnsportSportSummary[];
+    activity_labels?: string[];
+    activity_offers?: BarnsportActivityOffer[];
+}
+interface BarnsportProviderProfile extends BarnsportProvider {
+    reviews?: BarnsportReviewsSummary;
+    stats?: BarnsportStats;
+}
+interface BarnsportProvidersFilter {
+    q?: string;
+    municipality?: string;
+    sport?: string;
+    sort?: 'relevance' | 'name' | 'updated';
+    cursor?: string;
+    limit?: number;
+}
+interface BarnsportActivityOffersFilter {
+    q?: string;
+    municipality?: string;
+    sport?: string;
+    provider?: string;
+    birth_year?: number;
+    visibility?: 'barnsport' | 'confirmed' | 'register';
+    beginner_friendly?: boolean;
+    trial_available?: boolean;
+    low_cost?: boolean;
+    weekend_available?: boolean;
+    environment?: BarnsportActivityEnvironment;
+    cursor?: string;
+    limit?: number;
+}
+interface BarnsportCollectionResponse<T, TFilters = Record<string, unknown>> {
+    items: T[];
+    count?: number;
+    nextCursor?: string | null;
+    hasMore?: boolean;
+    filters?: TFilters;
+}
+interface BarnsportItemResponse<T> {
+    item: T;
+}
+interface BarnsportInquiryDelivery {
+    type: string;
+    status: string;
+    provider?: string;
+}
+interface BarnsportInquiryResponse {
+    success: boolean;
+    message: string;
+    delivery_status?: string;
+    request_kind?: 'interest' | 'contact_help';
+    activity_offer_slug?: string;
+    inquiry_contact_status?: string;
+    deliveries?: BarnsportInquiryDelivery[];
+}
+interface BarnsportFeedbackRequest {
+    token: string;
+    outcome: 'helped' | 'not_helped' | 'child_started' | 'not_a_fit';
+    honeypot?: string;
+    source?: {
+        site?: string;
+    };
+}
+interface BarnsportFeedbackResponse {
+    accepted: boolean;
+    feedback?: {
+        status: BarnsportFeedbackRequest['outcome'];
+    };
+}
+interface BarnsportReviewSubmissionRequest {
+    token: string;
+    rating: 1 | 2 | 3 | 4 | 5;
+    bodyText?: string;
+    displayNameChoice?: 'first_name' | 'anonymous';
+    honeypot?: string;
+    source?: {
+        site?: string;
+    };
+}
+interface BarnsportReviewSubmissionResponse {
+    accepted?: boolean;
+    review: {
+        id: string;
+        status: 'pending';
+    };
+}
+type BarnsportEventType = 'interest_form_viewed' | 'interest_submitted' | 'activity_offer_viewed' | 'provider_viewed' | 'search_performed' | 'filter_applied' | 'signup_link_clicked' | 'feedback_submitted';
+interface BarnsportEventRequest {
+    eventType: BarnsportEventType;
+    activitySlug?: string;
+    activityOfferSlug?: string;
+    providerSlug?: string;
+    sportSlug?: string;
+    municipalitySlug?: string;
+    metadata?: Record<string, string | number | boolean | undefined>;
+    honeypot?: string;
+    source?: {
+        site?: string;
+    };
+}
+interface BarnsportEventResponse {
+    accepted: boolean;
+    event?: {
+        id: string;
+        event_type: BarnsportEventType;
+        created_at: string;
+    };
+}
+
+declare function useBarnsportMunicipalities(): {
+    municipalities: BarnsportMunicipality[];
+    count: number;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<BarnsportListResponse<BarnsportMunicipality>, Error>>;
+};
+declare function useBarnsportSports(): {
+    sports: BarnsportSport[];
+    count: number;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<BarnsportListResponse<BarnsportSport>, Error>>;
+};
+declare function useBarnsportSport(slug: string | undefined): {
+    sport: BarnsportSport | null;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<{
+        sport: BarnsportSport;
+    }, Error>>;
+};
+declare function useBarnsportActivities(filters?: BarnsportActivitiesFilter): {
+    activities: BarnsportActivityListItem[];
+    count: number;
+    nextCursor: string | null;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<BarnsportListResponse<BarnsportActivityListItem>, Error>>;
+};
+declare function useBarnsportActivity(slug: string | undefined): {
+    activity: BarnsportActivity | null;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<BarnsportActivityResponse, Error>>;
+};
+declare function useBarnsportSitemap(baseUrl?: string): {
+    sitemap: BarnsportSitemapResponse | null;
+    urls: BarnsportSitemapUrl[];
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<BarnsportSitemapResponse, Error>>;
+};
+declare function useSubmitBarnsportInterest(): _tanstack_react_query.UseMutationResult<BarnsportInterestSubmissionResponse, Error, BarnsportInterestSubmissionRequest, unknown>;
+declare function useBarnsportProviderSearch(filters: BarnsportProvidersFilter): {
+    providers: BarnsportProvider[];
+    count: number;
+    nextCursor: string | null;
+    hasMore: boolean;
+    isLoading: boolean;
+    isFetching: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<BarnsportCollectionResponse<BarnsportProvider, BarnsportProvidersFilter>, Error>>;
+};
+declare function useBarnsportProvider(slug: string | undefined): {
+    provider: BarnsportProviderProfile | null;
+    isLoading: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<{
+        item: BarnsportProviderProfile;
+    }, Error>>;
+};
+declare function useBarnsportActivityOffers(filters?: BarnsportActivityOffersFilter): {
+    activityOffers: BarnsportActivityOffer[];
+    count: number;
+    nextCursor: string | null;
+    hasMore: boolean;
+    isLoading: boolean;
+    isFetching: boolean;
+    isError: boolean;
+    error: Error | null;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<BarnsportCollectionResponse<BarnsportActivityOffer, BarnsportActivityOffersFilter>, Error>>;
+};
+declare function useSubmitBarnsportFeedback(): _tanstack_react_query.UseMutationResult<BarnsportFeedbackResponse, Error, BarnsportFeedbackRequest, unknown>;
+declare function useSubmitBarnsportReview(): _tanstack_react_query.UseMutationResult<BarnsportReviewSubmissionResponse, Error, BarnsportReviewSubmissionRequest, unknown>;
+declare function useTrackBarnsportEvent(): _tanstack_react_query.UseMutationResult<BarnsportEventResponse, Error, BarnsportEventRequest, unknown>;
+
+export { type BarnsportYouthStatus as $, type BarnsportActivityOffersFilter as A, type BarnsportActivitiesFilter as B, type BarnsportActivityOffer as C, type BarnsportFeedbackRequest as D, type BarnsportFeedbackResponse as E, type BarnsportReviewSubmissionRequest as F, type BarnsportReviewSubmissionResponse as G, type BarnsportEventRequest as H, type BarnsportEventResponse as I, type BarnsportClubRemovalRequest as J, type BarnsportClubRemovalResponse as K, type BarnsportProviderUpdateRequest as L, type BarnsportProviderUpdateResponse as M, type BarnsportActivityEnvironment as N, type BarnsportCourseCandidate as O, type BarnsportEventType as P, type BarnsportInquiryDelivery as Q, type BarnsportInquiryResponse as R, type BarnsportMunicipalitySummary as S, type BarnsportProviderSummary as T, type BarnsportReview as U, type BarnsportReviewsSummary as V, type BarnsportSourceConfidence as W, type BarnsportSportArticle as X, type BarnsportSportSummary as Y, type BarnsportStats as Z, type BarnsportVerificationStatus as _, type BarnsportActivity as a, useBarnsportActivityOffers as a0, useBarnsportProvider as a1, useBarnsportProviderSearch as a2, useSubmitBarnsportFeedback as a3, useSubmitBarnsportReview as a4, useTrackBarnsportEvent as a5, type BarnsportActivityListItem as b, type BarnsportActivityLocation as c, type BarnsportActivityResponse as d, type BarnsportActivitySchedule as e, type BarnsportInquirySubmissionRequest as f, type BarnsportInterestSubmissionRequest as g, type BarnsportInterestSubmissionResponse as h, type BarnsportListResponse as i, type BarnsportMunicipality as j, type BarnsportRegistrationMethod as k, type BarnsportSitemapResponse as l, type BarnsportSitemapUrl as m, type BarnsportSport as n, useBarnsportActivity as o, useBarnsportMunicipalities as p, useBarnsportSitemap as q, useBarnsportSport as r, useBarnsportSports as s, useSubmitBarnsportInterest as t, useBarnsportActivities as u, type BarnsportProvidersFilter as v, type BarnsportCollectionResponse as w, type BarnsportProvider as x, type BarnsportItemResponse as y, type BarnsportProviderProfile as z };