@gomusdev/web-components 1.55.2 → 1.56.0

package/dist-js/{lib → src/lib}/models/cart/CartItem.d.ts

@@ -1,4 +1,4 @@
-import { Product } from './types.ts';
+import { Product } from '../../../../lib/models/cart/types.ts';
 interface Options {
     quantity?: number;
     time?: string;
@@ -8,25 +8,30 @@ interface Options {
         originalPrice: number;
     };
 }
-export declare function createCartItem<T extends Product>(product: T, options?: Partial<Options>): {
-    type: import('./types.ts').ProductType;
-    product: T;
+export declare function createCartItem(product: Product, options?: Partial<Options>): {
+    type: "Ticket" | "Event";
+    product: Product;
     /**
      * is passed to the Order API
      */
     orderAttributes(): {
+        time: string | undefined;
+        quantity: number | undefined;
         shipped_with_merchandise_id: null;
         shipping_mode: string;
         id: number;
-        time: string | undefined;
-        quantity: number | undefined;
     } | {
+        quantity: number | undefined;
         shipped_with_merchandise_id: null;
         shipping_mode: string;
         id: number;
+    } | {
         quantities: {
-            [x: number]: number | undefined;
+            [product.scale_price_id]: number | undefined;
         };
+        shipped_with_merchandise_id: null;
+        shipping_mode: string;
+        id: number;
     };
     uuid: string;
     subUId: string;

package/dist-js/src/lib/models/cart/cart.svelte.d.ts

@@ -0,0 +1,261 @@
+import { CartItem, Product } from '../../../../lib/models/cart/types.ts';
+export type Cart = ReturnType<typeof createCart>;
+export declare function createCart(products?: Product[], contingent?: number): {
+    items: {
+        type: "Ticket" | "Event";
+        product: Product;
+        orderAttributes(): {
+            time: string | undefined;
+            quantity: number | undefined;
+            shipped_with_merchandise_id: null;
+            shipping_mode: string;
+            id: number;
+        } | {
+            quantity: number | undefined;
+            shipped_with_merchandise_id: null;
+            shipping_mode: string;
+            id: number;
+        } | {
+            quantities: {
+                [x: number]: number | undefined;
+            };
+            shipped_with_merchandise_id: null;
+            shipping_mode: string;
+            id: number;
+        };
+        uuid: string;
+        subUId: string;
+        toString(): string;
+        price_cents: number;
+        price_formatted: string;
+        final_price_cents: number;
+        final_price_formatted: string;
+        total_price_cents: number;
+        total_price_formatted: string;
+        quantity?: number | undefined;
+        time?: string | undefined;
+        display?: {
+            discounted: boolean;
+            reference_uuid: string;
+            originalPrice: number;
+        } | undefined;
+    }[];
+    coupons: string[];
+    paymentModeId: undefined;
+    uid: string;
+    readonly nonEmptyItems: {
+        type: "Ticket" | "Event";
+        product: Product;
+        orderAttributes(): {
+            time: string | undefined;
+            quantity: number | undefined;
+            shipped_with_merchandise_id: null;
+            shipping_mode: string;
+            id: number;
+        } | {
+            quantity: number | undefined;
+            shipped_with_merchandise_id: null;
+            shipping_mode: string;
+            id: number;
+        } | {
+            quantities: {
+                [x: number]: number | undefined;
+            };
+            shipped_with_merchandise_id: null;
+            shipping_mode: string;
+            id: number;
+        };
+        uuid: string;
+        subUId: string;
+        toString(): string;
+        price_cents: number;
+        price_formatted: string;
+        final_price_cents: number;
+        final_price_formatted: string;
+        total_price_cents: number;
+        total_price_formatted: string;
+        quantity?: number | undefined;
+        time?: string | undefined;
+        display?: {
+            discounted: boolean;
+            reference_uuid: string;
+            originalPrice: number;
+        } | undefined;
+    }[];
+    readonly totalPriceCents: number;
+    readonly totalQuantity: number;
+    /**
+     * Generates a formatted string representation of the current object.
+     */
+    toString(): string;
+    orderData(): {
+        items: {
+            type: "Ticket" | "Event";
+            attributes: {
+                time: string | undefined;
+                quantity: number | undefined;
+                shipped_with_merchandise_id: null;
+                shipping_mode: string;
+                id: number;
+            } | {
+                quantity: number | undefined;
+                shipped_with_merchandise_id: null;
+                shipping_mode: string;
+                id: number;
+            } | {
+                quantities: {
+                    [x: number]: number | undefined;
+                };
+                shipped_with_merchandise_id: null;
+                shipping_mode: string;
+                id: number;
+            };
+        }[];
+        shipping_address_id: null;
+        comment: null;
+        reference: null;
+        payment_mode_id: string;
+        coupons: string[];
+        donations: never[];
+        affiliate: {};
+        total: number;
+    };
+    readonly totalFormatted: string;
+    clearItems(): void;
+    deleteItem(item: CartItem): void;
+    addItem(item: CartItem): void;
+    addItems(items: CartItem[]): void;
+    addCoupon(token: string): void;
+    removeCoupon(token: string): void;
+    clearCoupons(): void;
+};
+export declare function formatCurrency(priceCents: number): string;
+export declare function createMainCart(): {
+    items: {
+        type: "Ticket" | "Event";
+        product: Product;
+        orderAttributes(): {
+            time: string | undefined;
+            quantity: number | undefined;
+            shipped_with_merchandise_id: null;
+            shipping_mode: string;
+            id: number;
+        } | {
+            quantity: number | undefined;
+            shipped_with_merchandise_id: null;
+            shipping_mode: string;
+            id: number;
+        } | {
+            quantities: {
+                [x: number]: number | undefined;
+            };
+            shipped_with_merchandise_id: null;
+            shipping_mode: string;
+            id: number;
+        };
+        uuid: string;
+        subUId: string;
+        toString(): string;
+        price_cents: number;
+        price_formatted: string;
+        final_price_cents: number;
+        final_price_formatted: string;
+        total_price_cents: number;
+        total_price_formatted: string;
+        quantity?: number | undefined;
+        time?: string | undefined;
+        display?: {
+            discounted: boolean;
+            reference_uuid: string;
+            originalPrice: number;
+        } | undefined;
+    }[];
+    coupons: string[];
+    paymentModeId: undefined;
+    uid: string;
+    readonly nonEmptyItems: {
+        type: "Ticket" | "Event";
+        product: Product;
+        orderAttributes(): {
+            time: string | undefined;
+            quantity: number | undefined;
+            shipped_with_merchandise_id: null;
+            shipping_mode: string;
+            id: number;
+        } | {
+            quantity: number | undefined;
+            shipped_with_merchandise_id: null;
+            shipping_mode: string;
+            id: number;
+        } | {
+            quantities: {
+                [x: number]: number | undefined;
+            };
+            shipped_with_merchandise_id: null;
+            shipping_mode: string;
+            id: number;
+        };
+        uuid: string;
+        subUId: string;
+        toString(): string;
+        price_cents: number;
+        price_formatted: string;
+        final_price_cents: number;
+        final_price_formatted: string;
+        total_price_cents: number;
+        total_price_formatted: string;
+        quantity?: number | undefined;
+        time?: string | undefined;
+        display?: {
+            discounted: boolean;
+            reference_uuid: string;
+            originalPrice: number;
+        } | undefined;
+    }[];
+    readonly totalPriceCents: number;
+    readonly totalQuantity: number;
+    /**
+     * Generates a formatted string representation of the current object.
+     */
+    toString(): string;
+    orderData(): {
+        items: {
+            type: "Ticket" | "Event";
+            attributes: {
+                time: string | undefined;
+                quantity: number | undefined;
+                shipped_with_merchandise_id: null;
+                shipping_mode: string;
+                id: number;
+            } | {
+                quantity: number | undefined;
+                shipped_with_merchandise_id: null;
+                shipping_mode: string;
+                id: number;
+            } | {
+                quantities: {
+                    [x: number]: number | undefined;
+                };
+                shipped_with_merchandise_id: null;
+                shipping_mode: string;
+                id: number;
+            };
+        }[];
+        shipping_address_id: null;
+        comment: null;
+        reference: null;
+        payment_mode_id: string;
+        coupons: string[];
+        donations: never[];
+        affiliate: {};
+        total: number;
+    };
+    readonly totalFormatted: string;
+    clearItems(): void;
+    deleteItem(item: CartItem): void;
+    addItem(item: CartItem): void;
+    addItems(items: CartItem[]): void;
+    addCoupon(token: string): void;
+    removeCoupon(token: string): void;
+    clearCoupons(): void;
+};

package/dist-js/src/lib/models/cart/localStorage.svelte.d.ts

@@ -0,0 +1,56 @@
+import { Cart } from '../../../../lib/models/cart/cart.svelte.ts';
+import { CartItem } from '../../../../lib/models/cart/types.ts';
+/**
+ * Generates a cart item based on the provided json object.
+ *
+ * @param cartItem - The cart item object containing details such as type, attributes, and item.
+ * @return {CartItem | undefined} The generated cart item if applicable, otherwise undefined.
+ */
+export declare function generateCartItem(cartItem: any): CartItem | undefined;
+export declare function clearLocalStorage(): void;
+export declare function loadFromLocalStorage(cart: Cart): {
+    type: "Ticket" | "Event";
+    product: import('../../../../lib/models/cart/types.ts').Product;
+    orderAttributes(): {
+        time: string | undefined;
+        quantity: number | undefined;
+        shipped_with_merchandise_id: null;
+        shipping_mode: string;
+        id: number;
+    } | {
+        quantity: number | undefined;
+        shipped_with_merchandise_id: null;
+        shipping_mode: string;
+        id: number;
+    } | {
+        quantities: {
+            [x: number]: number | undefined;
+        };
+        shipped_with_merchandise_id: null;
+        shipping_mode: string;
+        id: number;
+    };
+    uuid: string;
+    subUId: string;
+    toString(): string;
+    price_cents: number;
+    price_formatted: string;
+    final_price_cents: number;
+    final_price_formatted: string;
+    total_price_cents: number;
+    total_price_formatted: string;
+    quantity?: number | undefined;
+    time?: string | undefined;
+    display?: {
+        discounted: boolean;
+        reference_uuid: string;
+        originalPrice: number;
+    } | undefined;
+}[];
+/**
+ * Synchronizes the given shopping cart with the local storage. The method ensures that the cart is loaded from local storage,
+ * updates are reflected in the local storage, and any external changes to the local storage are propagated to the cart.
+ *
+ * @return {void} This method does not return a value.
+ */
+export declare function syncCartToLocalStorage(cart: Cart): void;

package/dist-js/src/lib/models/cart/types.d.ts

@@ -0,0 +1,22 @@
+import { createCartItem } from '../../../../lib/models/cart/CartItem.ts';
+import { UIEventTicket } from '../../../../lib/models/eventTicket/UIEventTicket.svelte.ts';
+import { UITicket } from '../../../../lib/models/ticket/UITicket.svelte.ts';
+export type ProductType = 'Ticket' | 'Event';
+export type CartItem = ReturnType<typeof createCartItem>;
+/**
+ * minimal props to define a Product in a CartItem
+ */
+export type BaseProduct = {
+    id: number;
+    title: string;
+    description: string;
+    price_cents: number;
+    tax_included: boolean;
+    vat_pct: number;
+    type: ProductType;
+};
+export type Product = (UITicket & {
+    type: 'Ticket';
+}) | (UIEventTicket & {
+    type: 'Event';
+});

package/dist-js/src/lib/models/eventTicket/UIEventTicket.svelte.d.ts

@@ -0,0 +1,66 @@
+import { Product } from '../../../../lib/models/cart/types.ts';
+import { DateDetails, EventTicket } from '@gomus/types';
+interface Options {
+    minAvailableCapacity?: number;
+    selectedTime?: string;
+    quantity?: number;
+    date?: DateDetails;
+    event_title?: string;
+    event_subtitle?: string;
+    date_title?: string;
+    date_description?: string;
+    price_title?: string;
+    price_description?: string;
+}
+/**
+ * Event tickets come in two subtypes:
+ * - `flat`: single fixed price per ticket.
+ * - `scale`: price scales by attribute (e.g. age group), identified by `scale_price_id`.
+ *
+ * Subtype selection is automatic: derived from the API ticket's `scale_price_id`
+ * (absent → `flat`, present → `scale`). Consumers should not set it manually;
+ * use `isFlatEventTicket` / `isScaleEventTicket` to narrow.
+ */
+type UIEventTicketSubtype = 'scale' | 'flat';
+export declare function isEventTicket(x: Product): x is UIEventTicket;
+export declare function isFlatEventTicket(x: Product): x is UIEventTicketFlat;
+export declare function isScaleEventTicket(x: Product): x is UIEventTicketScale;
+export type UIEventTicketBase = ReturnType<typeof buildUIEventTicket>;
+export type UIEventTicketFlat = UIEventTicketBase & {
+    subtype: 'flat';
+    scale_price_id?: undefined;
+};
+export type UIEventTicketScale = UIEventTicketBase & {
+    subtype: 'scale';
+    scale_price_id: number;
+};
+export type UIEventTicket = UIEventTicketFlat | UIEventTicketScale;
+declare function buildUIEventTicket(apiTicket: EventTicket, dateId: number, options?: Options): {
+    type: "Event";
+    subtype: UIEventTicketSubtype;
+    group?: boolean;
+    optional?: boolean;
+    price_cents: number;
+    vat_pct: number;
+    accounting_article_id?: number;
+    accounting_article_type?: string;
+    description: string;
+    scale_price_id?: number;
+    title: string;
+    id: number;
+    tax_included: boolean;
+    minAvailableCapacity: number;
+    selectedTime: string;
+    quantity?: number;
+    date?: DateDetails;
+    event_title?: string;
+    event_subtitle?: string;
+    date_title?: string;
+    date_description?: string;
+    price_title?: string;
+    price_description?: string;
+    uid: number;
+    dateId: number;
+};
+export declare function createUIEventTicket(apiTicket: EventTicket, dateId: number, options?: Options): UIEventTicket;
+export {};

package/dist-js/{lib → src/lib}/models/ticket/UITicket.svelte.d.ts

@@ -1,16 +1,16 @@
-import { Product, ProductType } from '../cart/types.ts';
+import { BaseProduct } from '../../../../lib/models/cart/types.ts';
 import { AnnualTicket, NormalTickets, Ticket, Tickets } from '@gomus/types';
 interface Options {
     selectedTime?: string;
 }
 export type UITicketType = 'timeslot' | 'annual' | 'day' | 'event:ticket';
 export type UITicket = ReturnType<typeof createUITicket>;
-export declare function isUITicket(x: Product): x is UITicket;
+export declare function isUITicket(x: BaseProduct): x is UITicket;
 export declare function createUITicket(apiTicket: Ticket | AnnualTicket | NormalTickets[number], options?: Options): {
     uid: number;
     selectedTime: string;
-    product_type: ProductType;
-    type: UITicketType;
+    type: "Ticket";
+    subtype: UITicketType;
     shop_order: number;
     id: number;
     title: string;
@@ -65,8 +65,8 @@ export declare function createUITicket(apiTicket: Ticket | AnnualTicket | Normal
 } | {
     uid: number;
     selectedTime: string;
-    product_type: ProductType;
-    type: UITicketType;
+    type: "Ticket";
+    subtype: UITicketType;
     shop_order: number;
     id: number;
     title: string;
@@ -113,8 +113,8 @@ export declare function createUITicket(apiTicket: Ticket | AnnualTicket | Normal
 } | {
     uid: number;
     selectedTime: string;
-    product_type: ProductType;
-    type: UITicketType;
+    type: "Ticket";
+    subtype: UITicketType;
     shop_order: number;
     id: number;
     title: string;

package/dist-js/{lib → src/lib}/stores/shop.svelte.d.ts

@@ -1,9 +1,9 @@
-import { CalendarDates, CalendarDatesDepthAvailabilityStatus } from '../../components/ticketSelection/subcomponents/calendar/lib/calendar.svelte.ts';
-import { ShopUrls } from '../helpers/urls';
-import { CapacityManager } from '../models/capacity/CapacityManager.ts';
-import { Cart } from '../models/cart/cart.svelte.ts';
-import { Auth } from './auth.svelte.ts';
-import { User } from './user.svelte.ts';
+import { CalendarDates, CalendarDatesDepthAvailabilityStatus } from '../../../components/ticketSelection/subcomponents/calendar/lib/calendar.svelte.ts';
+import { ShopUrls } from '../../../lib/helpers/urls';
+import { CapacityManager } from '../../../lib/models/capacity/CapacityManager.ts';
+import { Cart } from '../../../lib/models/cart/cart.svelte.ts';
+import { Auth } from '../../../lib/stores/auth.svelte.ts';
+import { User } from '../../../lib/stores/user.svelte.ts';
 import { OpenApiClient } from '@gomus/api';
 import { TicketsAndQuotasParams, TicketsCalendarParams, TicketsParams } from '@gomus/api/lib/types.ts';
 import { CapacitiesResponse, CheckoutParams, CheckoutResponse, Country, Event, Exhibition, FinalizePersonalizationParams, FinalizePersonalizationResponse, LocaleOptions, Merchandise, Museum, PasswordResetResponse, PasswordUpdateResponse, PostCartParams, PostCartResponse, Salutation, ShopType, SignInParams, SignInResponse, SignUpParams, SignUpResponse, Tour, ValidateTokenResponse } from '@gomus/types';
@@ -14,7 +14,7 @@ export declare class Shop {
     constructor();
     load(apiUrl: string, shopDomain: string, locale: string, type?: ShopKind): Promise<void>;
     get capacityManager(): {
-        allSeats: Record<import('../models/capacity/CapacityManager.ts').DateID, import('../models/capacity/CapacityManager.ts').Seats>;
+        allSeats: Record<import('../../../lib/models/capacity/CapacityManager.ts').DateID, import('../../../lib/models/capacity/CapacityManager.ts').Seats>;
         allQuotas: import('@gomus/types').Quotas;
         quotaManager: {
             apiData: {
@@ -68,35 +68,116 @@ export declare class Shop {
             }[];
         };
         addQuotas(quotas: import('@gomus/types').Quotas, saveToLocalStorage?: boolean): void;
-        addSeats(dateId: import('../models/capacity/CapacityManager.ts').DateID, seats: import('../models/capacity/CapacityManager.ts').Seats, saveToLocalStorage?: boolean): void;
+        addSeats(dateId: import('../../../lib/models/capacity/CapacityManager.ts').DateID, seats: import('../../../lib/models/capacity/CapacityManager.ts').Seats, saveToLocalStorage?: boolean): void;
         capacityPolicy(item: import('../models/cart/types').CartItem): "quotas" | "unlimited" | "seats";
         capacity(cart: Cart, item: import('../models/cart/types').CartItem, preCart: Cart): import('../models/capacity/types').Capacity;
     };
     get cart(): {
-        items: import('../models/cart/types').CartItem[];
+        items: {
+            type: "Ticket" | "Event";
+            product: import('../models/cart/types').Product;
+            orderAttributes(): {
+                time: string | undefined;
+                quantity: number | undefined;
+                shipped_with_merchandise_id: null;
+                shipping_mode: string;
+                id: number;
+            } | {
+                quantity: number | undefined;
+                shipped_with_merchandise_id: null;
+                shipping_mode: string;
+                id: number;
+            } | {
+                quantities: {
+                    [x: number]: number | undefined;
+                };
+                shipped_with_merchandise_id: null;
+                shipping_mode: string;
+                id: number;
+            };
+            uuid: string;
+            subUId: string;
+            toString(): string;
+            price_cents: number;
+            price_formatted: string;
+            final_price_cents: number;
+            final_price_formatted: string;
+            total_price_cents: number;
+            total_price_formatted: string;
+            quantity?: number | undefined;
+            time?: string | undefined;
+            display?: {
+                discounted: boolean;
+                reference_uuid: string;
+                originalPrice: number;
+            } | undefined;
+        }[];
         coupons: string[];
         paymentModeId: undefined;
         uid: string;
-        readonly nonEmptyItems: import('../models/cart/types').CartItem[];
+        readonly nonEmptyItems: {
+            type: "Ticket" | "Event";
+            product: import('../models/cart/types').Product;
+            orderAttributes(): {
+                time: string | undefined;
+                quantity: number | undefined;
+                shipped_with_merchandise_id: null;
+                shipping_mode: string;
+                id: number;
+            } | {
+                quantity: number | undefined;
+                shipped_with_merchandise_id: null;
+                shipping_mode: string;
+                id: number;
+            } | {
+                quantities: {
+                    [x: number]: number | undefined;
+                };
+                shipped_with_merchandise_id: null;
+                shipping_mode: string;
+                id: number;
+            };
+            uuid: string;
+            subUId: string;
+            toString(): string;
+            price_cents: number;
+            price_formatted: string;
+            final_price_cents: number;
+            final_price_formatted: string;
+            total_price_cents: number;
+            total_price_formatted: string;
+            quantity?: number | undefined;
+            time?: string | undefined;
+            display?: {
+                discounted: boolean;
+                reference_uuid: string;
+                originalPrice: number;
+            } | undefined;
+        }[];
         readonly totalPriceCents: number;
         readonly totalQuantity: number;
         toString(): string;
         orderData(): {
             items: {
-                type: import('../models/cart/types').ProductType;
+                type: "Ticket" | "Event";
                 attributes: {
+                    time: string | undefined;
+                    quantity: number | undefined;
                     shipped_with_merchandise_id: null;
                     shipping_mode: string;
                     id: number;
-                    time: string | undefined;
-                    quantity: number | undefined;
                 } | {
+                    quantity: number | undefined;
                     shipped_with_merchandise_id: null;
                     shipping_mode: string;
                     id: number;
+                } | {
                     quantities: {
                         [x: number]: number | undefined;
                     };
+                    shipped_with_merchandise_id: null;
+                    shipping_mode: string;
+                    id: number;
                 };
             }[];
             shipping_address_id: null;

package/dist-js/{lib → src/lib}/vitest/msw/handlers.d.ts

@@ -1487,7 +1487,7 @@ export function getGetTickets200Response(): {
     tickets: {
         id: number;
         title: string;
-        ticket_type: "annual" | "time_slot" | "normal";
+        ticket_type: "time_slot" | "annual" | "normal";
         bookable: boolean;
         museum_ids: number[];
         exhibition_ids: number[];

package/dist-js/{mocks → src/mocks}/MSWMocks.d.ts

@@ -1,4 +1,4 @@
-import { LogAllRequests } from '../lib/vitest/msw/vitestMSWSetup.ts';
+import { LogAllRequests } from '../../lib/vitest/msw/vitestMSWSetup.ts';
 export declare const MSWMocks: {
     logAllRequests: typeof LogAllRequests;
     mockAndLoadShop: () => void;

package/dist-js/src/workflowSpecs/cart-respects-capacity.spec.d.ts

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

package/dist-js/src/workflowSpecs/flat-event-workflow.spec.d.ts

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