@gomusdev/web-components 1.7.0 → 1.8.0

package/dist-js/lib/helpers/urls.d.ts

@@ -0,0 +1,64 @@
+export type ShopUrls = typeof ANGULAR_URLS;
+declare const ANGULAR_URLS: {
+    account: () => string;
+    annualTickets: () => string;
+    checkoutFailure: (errorMessage: string) => string;
+    checkoutSuccess: (token: string) => string;
+    checkoutForm: () => string;
+    coupons: () => string;
+    combiTickets: () => string;
+    combiTicketGroup: (slug: string) => string;
+    dayTickets: () => string;
+    eventGroup: typeof eventGroupUrl;
+    event: (id: number) => string;
+    events: () => string;
+    exhibition: (id: number) => string;
+    exhibitions: () => string;
+    home: () => string;
+    login: () => string;
+    merchandise: (id: number) => string;
+    merchandises: () => string;
+    museum: (id: number) => string;
+    museums: () => string;
+    publicTours: () => string;
+    register: () => string;
+    tickets: () => string;
+    ticketGroup: (slug: string) => string;
+    tour: (id: number) => string;
+    tours: () => string;
+    toursGroup: typeof toursGroupUrl;
+    cart: () => string;
+};
+export declare function shopUrlProvider(type: 'angular' | 'jmb'): {
+    account: () => string;
+    annualTickets: () => string;
+    checkoutFailure: (errorMessage: string) => string;
+    checkoutSuccess: (token: string) => string;
+    checkoutForm: () => string;
+    coupons: () => string;
+    combiTickets: () => string;
+    combiTicketGroup: (slug: string) => string;
+    dayTickets: () => string;
+    eventGroup: typeof eventGroupUrl;
+    event: (id: number) => string;
+    events: () => string;
+    exhibition: (id: number) => string;
+    exhibitions: () => string;
+    home: () => string;
+    login: () => string;
+    merchandise: (id: number) => string;
+    merchandises: () => string;
+    museum: (id: number) => string;
+    museums: () => string;
+    publicTours: () => string;
+    register: () => string;
+    tickets: () => string;
+    ticketGroup: (slug: string) => string;
+    tour: (id: number) => string;
+    tours: () => string;
+    toursGroup: typeof toursGroupUrl;
+    cart: () => string;
+};
+declare function eventGroupUrl(id: number): string;
+declare function toursGroupUrl(id: number): string;
+export {};

package/dist-js/lib/helpers/utils.d.ts

@@ -0,0 +1,24 @@
+export declare function currency(value: number, currency: string): string;
+/**
+ * Parses a comma-separated string of IDs into an array of positive numbers.
+ *
+ * This function takes a string containing comma-separated values and converts
+ * them into an array of positive integers. Invalid values (non-numeric, zero,
+ * or negative numbers) are filtered out.
+ *
+ * @param ids - A comma-separated string of IDs (e.g., "1,2,3" or "10, 20, 30")
+ * @returns An array of positive numbers if valid IDs are found, undefined otherwise
+ *
+ * @example
+ * ```ts
+ * parseIds("1,2,3") // Returns [1, 2, 3]
+ * parseIds("10, 20, 30") // Returns [10, 20, 30] (handles whitespace)
+ * parseIds("1,abc,3") // Returns [1, 3] (filters out invalid values)
+ * parseIds("0,-1,2") // Returns [2] (filters out zero and negative numbers)
+ * parseIds("") // Returns undefined
+ * parseIds(undefined) // Returns undefined
+ * parseIds("abc,def") // Returns undefined (no valid IDs)
+ * ```
+ */
+export declare function parseIds(ids: string | undefined): number[] | undefined;
+export declare function parseTokens<ValidToken>(tokens: string | undefined, possibleTokens: readonly ValidToken[]): ValidToken[] | undefined;

package/dist-js/lib/helpers/wrapInElement.d.ts

@@ -0,0 +1 @@
+export declare function wrapInElement(host: HTMLElement, tag: string, props?: Record<string, string | boolean>): HTMLElement;

package/dist-js/lib/helpers/wrapInElement.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist-js/lib/middlewares/AuthMiddleware.d.ts

@@ -0,0 +1,23 @@
+import { Middleware } from 'openapi-fetch';
+import { Auth } from '../stores/auth.svelte.ts';
+type MiddlewareLike = {
+    onRequest?: Middleware['onRequest'];
+    onResponse?: Middleware['onResponse'];
+};
+export declare class AuthMiddleware implements MiddlewareLike {
+    private readonly auth;
+    constructor(auth: Auth);
+    /**
+     * Intercepts and modifies outgoing HTTP requests by adding authentication headers.
+     */
+    onRequest({ request }: {
+        request: Request;
+    }): void;
+    /**
+     * Intercepts HTTP responses and updates authentication state if new credentials are received.
+     */
+    onResponse({ response }: {
+        response: Response;
+    }): Response;
+}
+export {};

package/dist-js/lib/middlewares/AuthMiddleware.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist-js/lib/stores/__mocks__/shop.svelte.d.ts

@@ -0,0 +1,2 @@
+export declare const shop: Record<string, any>;
+export type MockedShop = typeof shop;

package/dist-js/lib/stores/auth.svelte.d.ts

@@ -0,0 +1,25 @@
+export declare class Auth {
+    #private;
+    constructor();
+    customerLevel(): 20 | 10 | undefined;
+    isAuthenticated(): boolean;
+    isLoggedIn(): boolean;
+    isGuest(): boolean;
+    signOut(): void;
+    signIn(options: {
+        uid: string;
+        client: string;
+        accessToken: string;
+        expiry: number;
+    }): void;
+    get data(): {
+        uid: string;
+        client: string;
+        accessToken: string;
+        expiry: number;
+    };
+    toString(): string;
+    save(): void;
+    load(): void;
+}
+export declare const auth: Auth;

package/dist-js/lib/stores/auth.svelte.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist-js/lib/stores/shop.svelte.d.ts

@@ -0,0 +1,412 @@
+import { CalendarDates } from '../../components/ticketSelection/subcomponents/calendar/lib/calendar.svelte.ts';
+import { ShopUrls } from '../helpers/urls';
+import { User } from './user.svelte.ts';
+import { OpenApiClient } from '@gomus/api';
+import { TicketsAndQuotasParams, TicketsCalendarParams, TicketsParams } from '@gomus/api/lib/types.ts';
+import { CheckoutParams, CheckoutResponse, Country, Event, Exhibition, Merchandise, Museum, Salutation, ShopType, SignInParams, SignInResponse, SignUpParams, SignUpResponse, Tour } from '@gomus/types';
+export type ShopKind = 'angular' | 'jmb';
+export declare class Shop {
+    #private;
+    type: ShopKind;
+    constructor();
+    load(apiUrl: string, shopDomain: string, locale: string, type?: ShopKind): Promise<void>;
+    get currentUser(): User | undefined;
+    get slug(): string | undefined;
+    get client(): OpenApiClient | undefined;
+    get name(): string;
+    get config(): {
+        url: string;
+        success_link: string;
+        pending_link: string;
+        fail_link: string;
+        back_link: string;
+        confirmation_link: string;
+        password_reset_link: string;
+        personalization_link: string;
+        registration: boolean;
+        guest: {
+            enabled: boolean;
+            limit: number | null;
+        };
+        min_total: number | null;
+        max_total: number | null;
+        defaults: {
+            price_target_audience_id: number | null;
+        };
+        currency: string;
+        time_zone: string;
+        locale: string;
+        custom_css: string | null;
+        custom_js: string | null;
+        donations?: {
+            enabled: boolean;
+            campaigns?: {
+                id: number;
+                name: string;
+                options: number[];
+                guest_limit: number;
+                free_donations: boolean;
+                translations: {
+                    [key: string]: string;
+                };
+                picture: {
+                    original?: string | null;
+                    thumbnail?: string | null;
+                };
+            }[];
+        };
+        dynamic_pricing: boolean;
+        tickets: {
+            zip_file: boolean;
+        };
+    };
+    get payment_modes(): {
+        [key: string]: {
+            id: number;
+            name: string;
+            icons: string[];
+        };
+    };
+    get content(): {
+        [key: string]: string;
+    };
+    get settings(): import('@gomus/types').Settings;
+    get donations(): {
+        enabled: boolean;
+        campaigns?: {
+            id: number;
+            name: string;
+            options: number[];
+            guest_limit: number;
+            free_donations: boolean;
+            translations: {
+                [key: string]: string;
+            };
+            picture: {
+                original?: string | null;
+                thumbnail?: string | null;
+            };
+        }[];
+    } | undefined;
+    get translations(): {
+        [key: string]: string;
+    };
+    get currency(): string;
+    t(key: string, values?: {
+        [key: string]: string | number;
+    }): string;
+    translate(key: string, values?: {
+        [key: string]: string | number;
+    }): string;
+    get apiUrl(): string | undefined;
+    get shopDomain(): string | undefined;
+    get baseUrl(): string;
+    get locale(): string | undefined;
+    get shop(): ShopType;
+    get _data(): {
+        apiUrl?: string;
+        client?: OpenApiClient;
+        currentUser?: User;
+        exhibitions?: Exhibition[];
+        events?: Event[];
+        locale?: string;
+        merchandises?: Merchandise[];
+        museums?: Museum[];
+        shop?: ShopType;
+        shopDomain?: string;
+        tours?: Tour[];
+        urls?: ShopUrls;
+        customerSalutations?: Salutation[];
+        countries?: Country[];
+    };
+    ticketsCalendar(params: TicketsCalendarParams): CalendarDates;
+    ticketsAndQuotas(params: TicketsAndQuotasParams): {
+        tickets: {
+            [key: string]: import('@gomus/types').components["schemas"]["shop_v4_ticket_capacity"];
+        };
+        quotas: {
+            [key: string]: import('@gomus/types').components["schemas"]["quota"];
+        };
+        meta: import('@gomus/types').components["schemas"]["meta"];
+    };
+    tickets(params: TicketsParams): {
+        [key: string]: {
+            id: number;
+            title: string;
+            ticket_type: "time_slot" | "annual" | "normal";
+            bookable: boolean;
+            museum_ids: number[];
+            exhibition_ids: number[];
+            price_cents: number;
+            discount: number;
+            vat_pct: number;
+            tax_included: boolean;
+            entry_duration: number | null;
+            min_persons: number;
+            max_persons: number;
+            quota_ids: number[];
+            first_entry: number;
+            last_entry: number;
+            personalizeable: boolean;
+            attendees: boolean | string;
+            identification: boolean | string;
+            free_timing: boolean;
+            is_collective: boolean;
+            is_upgrade: boolean;
+            is_mantle: boolean;
+            description: string | null;
+            sub_ticket_ids: number[];
+            sub_tickets: {
+                [key: string]: {
+                    title?: string;
+                    min_persons?: number;
+                    max_persons?: number;
+                    description?: string | null;
+                };
+            } | null;
+            is_sub_ticket: boolean;
+            created_at: string;
+            updated_at: string;
+            shop_order: number;
+            shipped_with_merchandise_id: number | null;
+            restricted_shop_account: boolean;
+            cash_point_order: number;
+            capacities: {
+                [key: string]: number;
+            };
+            total_capacities: {
+                [key: string]: number;
+            };
+            max_capacity: number;
+            max_total_capacity: number;
+            dynamic_prices: {
+                [key: string]: number;
+            } | null;
+        };
+    };
+    signIn(params: SignInParams): Promise<SignInResponse>;
+    signUp(params: SignUpParams, asGuest?: boolean): Promise<SignUpResponse>;
+    checkout(params: CheckoutParams): Promise<CheckoutResponse>;
+    /**
+     * Returns a reactive value that will contain the fetched data, no need to await.
+     *
+     * @param {`/api${string}`} endpoint - The API endpoint to fetch data from. Must start with `/api`.
+     * @param {string} dataKey - The key where the fetched data will be stored in `shop.#data`.
+     * @param {string} responseKey - The key in the API response that contains the desired data.
+     * @param [options]
+     *   - query: A record of query parameters to include in the API request.
+     *   - cache: The cache duration (in seconds) before data is considered expired. Defaults to 1000 seconds if not provided.
+     * @return {T} The data fetched from the API or the cached data if it is still valid.
+     */
+    fetchAndCache<T>(endpoint: `/api${string}`, dataKey: string, responseKey: string, options?: {
+        query?: Record<string, unknown>;
+        cache?: number | undefined;
+    }): T;
+    get museums(): {
+        id: number;
+        title: string;
+        sub_title: string | null;
+        created_at: string;
+        updated_at: string;
+        picture: import('@gomus/types').components["schemas"]["picture"];
+    }[];
+    get exhibitions(): {
+        id: number;
+        museum_id: number;
+        foreign_id: string | null;
+        title: string;
+        sub_title: string | null;
+        created_at: string;
+        updated_at: string;
+        featured: boolean;
+        description: string | null;
+        picture: import('@gomus/types').components["schemas"]["picture"];
+        time_frames: {
+            start_at?: string;
+            end_at?: string;
+        }[];
+        location: import('@gomus/types').components["schemas"]["location"];
+    }[];
+    getEvent(id: number): {
+        id: number;
+        description: string | null;
+        museum_id: number;
+        exhibition_id: number | null;
+        foreign_id: string | null;
+        title: string;
+        sub_title: string | null;
+        created_at: string;
+        updated_at: string;
+        featured: boolean;
+        bookable: boolean;
+        registerable: boolean;
+        picture: import('@gomus/types').components["schemas"]["picture"];
+        duration: number;
+        location: import('@gomus/types').components["schemas"]["location"];
+        age_groups: import('@gomus/types').components["schemas"]["name_id_pair"];
+        audiences: import('@gomus/types').components["schemas"]["name_id_pair"];
+        catch_words: import('@gomus/types').components["schemas"]["name_id_pair"];
+        disablements: import('@gomus/types').components["schemas"]["name_id_pair"];
+        grades: import('@gomus/types').components["schemas"]["name_id_pair"];
+        proposal_categories: import('@gomus/types').components["schemas"]["name_id_pair"];
+        languages: import('@gomus/types').components["schemas"]["language"][];
+        category: import('@gomus/types').components["schemas"]["category"];
+        upcoming_bookings_start_times: string[];
+        tickets: number[];
+        quotas: number[];
+        ticket_sales_in_shop: boolean;
+        dates: {
+            first: string;
+            last: string;
+            count: number;
+        };
+        sellabilities: import('@gomus/types').components["schemas"]["time_frame"][];
+        documents: import('@gomus/types').components["schemas"]["document"][];
+        content: Record<string, never>;
+    };
+    get events(): {
+        id: number;
+        description: string | null;
+        museum_id: number;
+        exhibition_id: number | null;
+        foreign_id: string | null;
+        title: string;
+        sub_title: string | null;
+        created_at: string;
+        updated_at: string;
+        featured: boolean;
+        bookable: boolean;
+        registerable: boolean;
+        picture: import('@gomus/types').components["schemas"]["picture"];
+        duration: number;
+        location: import('@gomus/types').components["schemas"]["location"];
+        age_groups: import('@gomus/types').components["schemas"]["name_id_pair"];
+        audiences: import('@gomus/types').components["schemas"]["name_id_pair"];
+        catch_words: import('@gomus/types').components["schemas"]["name_id_pair"];
+        disablements: import('@gomus/types').components["schemas"]["name_id_pair"];
+        grades: import('@gomus/types').components["schemas"]["name_id_pair"];
+        proposal_categories: import('@gomus/types').components["schemas"]["name_id_pair"];
+        languages: import('@gomus/types').components["schemas"]["language"][];
+        category: import('@gomus/types').components["schemas"]["category"];
+        upcoming_bookings_start_times: string[];
+    }[];
+    get upcomingEvents(): {
+        id: number;
+        description: string | null;
+        museum_id: number;
+        exhibition_id: number | null;
+        foreign_id: string | null;
+        title: string;
+        sub_title: string | null;
+        created_at: string;
+        updated_at: string;
+        featured: boolean;
+        bookable: boolean;
+        registerable: boolean;
+        picture: import('@gomus/types').components["schemas"]["picture"];
+        duration: number;
+        location: import('@gomus/types').components["schemas"]["location"];
+        age_groups: import('@gomus/types').components["schemas"]["name_id_pair"];
+        audiences: import('@gomus/types').components["schemas"]["name_id_pair"];
+        catch_words: import('@gomus/types').components["schemas"]["name_id_pair"];
+        disablements: import('@gomus/types').components["schemas"]["name_id_pair"];
+        grades: import('@gomus/types').components["schemas"]["name_id_pair"];
+        proposal_categories: import('@gomus/types').components["schemas"]["name_id_pair"];
+        languages: import('@gomus/types').components["schemas"]["language"][];
+        category: import('@gomus/types').components["schemas"]["category"];
+        upcoming_bookings_start_times: string[];
+    }[];
+    get tours(): {
+        id: number;
+        exhibition_id?: number | null;
+        museum_id: number;
+        foreign_id?: number | null;
+        min_persons?: number;
+        max_persons?: number;
+        title: string;
+        sub_title?: string | null;
+        bookable: boolean;
+        registerable: boolean;
+        featured: boolean;
+        category: {
+            id: number;
+            name: string;
+            filtername: string | null;
+        };
+        equipment: boolean;
+        picture: import('@gomus/types').components["schemas"]["picture"];
+        created_at?: string;
+        updated_at?: string;
+        duration?: number;
+        location: import('@gomus/types').components["schemas"]["location"];
+        age_groups: Record<string, never>[];
+        audiences: Record<string, never>[];
+        catch_words: Record<string, never>[];
+        disablements: Record<string, never>[];
+        grades: Record<string, never>[];
+        proposal_categories: import('@gomus/types').components["schemas"]["name_id_pair"];
+        languages: import('@gomus/types').components["schemas"]["language"][];
+    }[];
+    get merchandises(): {
+        merchandise?: {
+            id?: number;
+            title?: string;
+            sub_title?: string | null;
+            description?: string | null;
+            price_cents?: number;
+            vat_pct?: number;
+            tax_included?: boolean;
+            sellable?: boolean;
+            content?: import('@gomus/types').components["schemas"]["object_content"];
+            picture?: import('@gomus/types').components["schemas"]["picture"];
+            created_at?: string;
+            updated_at?: string;
+            shipped_with_merchandise_id?: number | null;
+            is_shipping_article?: boolean;
+        };
+    }[];
+    get customerSalutations(): {
+        id: number;
+        salutation: string;
+    }[];
+    get countries(): {
+        id: number;
+        name: string;
+    }[];
+    get urls(): {
+        account: () => string;
+        annualTickets: () => string;
+        checkoutFailure: (errorMessage: string) => string;
+        checkoutSuccess: (token: string) => string;
+        checkoutForm: () => string;
+        coupons: () => string;
+        combiTickets: () => string;
+        combiTicketGroup: (slug: string) => string;
+        dayTickets: () => string;
+        eventGroup: (id: number) => string;
+        event: (id: number) => string;
+        events: () => string;
+        exhibition: (id: number) => string;
+        exhibitions: () => string;
+        home: () => string;
+        login: () => string;
+        merchandise: (id: number) => string;
+        merchandises: () => string;
+        museum: (id: number) => string;
+        museums: () => string;
+        publicTours: () => string;
+        register: () => string;
+        tickets: () => string;
+        ticketGroup: (slug: string) => string;
+        tour: (id: number) => string;
+        tours: () => string;
+        toursGroup: (id: number) => string;
+        cart: () => string;
+    } | undefined;
+    apiPost<T>(path: string, { body }: {
+        body: Record<string, any>;
+    }): Promise<T>;
+    waitForAllFetches(...variables: unknown[]): Promise<void>;
+    apiGet(path: `/api${string}`, query?: Record<string, unknown>): Promise<unknown>;
+}
+export declare const shop: Shop;

package/dist-js/lib/stores/shop.svelte.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist-js/lib/stores/user.svelte.d.ts

@@ -0,0 +1,16 @@
+import { ShopKind } from './shop.svelte';
+export declare abstract class User {
+    abstract get isLoggedIn(): boolean;
+    abstract get isGuest(): boolean;
+    get isAuthenticated(): boolean;
+}
+export declare class AngularUser extends User {
+    constructor();
+    get isLoggedIn(): boolean;
+    get isGuest(): boolean;
+}
+export declare class JMBUser extends User {
+    get isGuest(): boolean;
+    get isLoggedIn(): boolean;
+}
+export declare const getUserProvider: (type: ShopKind) => User;

package/dist-js/lib/stores/user.svelte.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist-js/lib/storybook/WrapperComponent.d.ts

@@ -0,0 +1 @@
+export {};

package/dist-js/lib/storybook/sbGlobals.svelte.d.ts

@@ -0,0 +1,9 @@
+export declare const sbGlobals: {
+    shop: string;
+    env: string;
+    locale: string;
+    styles: string;
+};
+export declare const onStoryBook: {
+    value: boolean;
+};

package/dist-js/lib/types/types.d.ts

@@ -0,0 +1 @@
+export {};

package/dist-js/lib/utils.d.ts

@@ -0,0 +1,16 @@
+export declare function wait(ms: number): Promise<unknown>;
+export declare function isEmail(email: string): boolean;
+export declare function isBoolean(value: unknown): value is boolean;
+/**
+ * Repeatedly invokes a callback function at regular intervals until it returns a truthy value,
+ * or until a timeout is reached. Resolves with the truthy result or `undefined` if the timeout expires.
+ * If the callback throws an error at any point, the promise will be rejected with that error.
+ *
+ * @param {Function} callback A function to be repeatedly invoked. It should return a value
+ *                            which will be checked for truthiness. If it throws an error,
+ *                            the polling will stop, and the returned promise will be rejected.
+ * @return {Promise<any>} A promise that resolves with the first truthy value returned by the callback,
+ *                        `undefined` if the timeout is reached without any truthy value,
+ *                        or rejects if the callback throws an error.
+ */
+export declare function pollUntilTruthy(callback: () => any): Promise<any>;

package/dist-js/lib/vitest/mockedCookies.d.ts

@@ -0,0 +1,2 @@
+import { Cookies } from '@sveltejs/kit';
+export declare const mockedCookies: Cookies;

package/dist-js/lib/vitest/msw/RequestLogger.d.ts

@@ -0,0 +1 @@
+export declare function attachMswLogger(server: any): void;

package/dist-js/lib/vitest/msw/basicHandlers.d.ts

@@ -0,0 +1,3 @@
+/** Monitors an incoming request, perform it and log the response */
+export declare const monitor: import('msw').HttpHandler;
+export declare const networkError: import('msw').HttpHandler;