@sixtyninecommerce/client 0.2.2 → 0.3.0

package/dist/types.d.ts

@@ -1,3 +1,10 @@
+export interface RetryConfig {
+    attempts?: number;
+    baseDelayMs?: number;
+}
+export interface RequestOptions {
+    signal?: AbortSignal;
+}
 export interface StorefrontClientConfig {
     storeCode: string;
     cdnUrl: string;
@@ -6,6 +13,9 @@ export interface StorefrontClientConfig {
     pluginsUrl?: string;
     defaultLanguageCode?: string;
     fetch?: typeof globalThis.fetch;
+    onAuthToken?: (token: string) => void;
+    onAuthExpired?: () => void;
+    retry?: RetryConfig;
 }
 export interface ChannelInfo {
     id: string;
@@ -18,6 +28,7 @@ export interface ChannelInfo {
 export interface StoreContext {
     channel: ChannelInfo;
     cdnUrl: string;
+    channelCdnDomain: string | null;
     vendureUrl: string;
     cmsUrl: string;
     pluginsUrl: string;
@@ -25,6 +36,12 @@ export interface StoreContext {
     currencyCode: string;
     authToken: string | null;
     fetch: typeof globalThis.fetch;
+    onAuthToken?: (token: string) => void;
+    onAuthExpired?: () => void;
+    retry: {
+        attempts: number;
+        baseDelayMs: number;
+    };
 }
 export interface GraphQLResponse<T = unknown> {
     data: T;
@@ -33,6 +50,12 @@ export interface GraphQLResponse<T = unknown> {
         path?: string[];
     }>;
 }
+export interface AgeVerificationStatus {
+    required: boolean;
+    minimumAge: number | null;
+    verified: boolean;
+    dateOfBirth: string | null;
+}
 export interface AssetPresetSize {
     url: string;
     webpUrl: string;
@@ -54,6 +77,32 @@ export interface Asset {
     };
     presets?: AssetPresets;
 }
+export interface CmsAssetTranslation {
+    language_code: string;
+    alt_text: string | null;
+}
+export interface CmsAsset {
+    id: string;
+    filename: string;
+    mime_type: string;
+    file_size: number;
+    storage_key: string;
+    content_hash: string | null;
+    width: number | null;
+    height: number | null;
+    alt_text: string | null;
+    presets: Record<PresetName, {
+        url: string;
+        webp_url: string;
+        width: number;
+        height: number;
+    }> | null;
+    translations: CmsAssetTranslation[];
+}
+export interface VendureAssetDescriptionTranslation {
+    language_code: string;
+    description: string;
+}
 export interface PriceTier {
     minQuantity: number;
     price: number;
@@ -83,7 +132,12 @@ export interface ProductVariant {
     retailPriceWithTax: number | null;
     priceTiers: PriceTier[] | null;
     options: ProductOption[];
+    featuredAsset: Asset | null;
     assets: Asset[];
+    customFields: {
+        minOrderQuantity: number | null;
+        salesUnit: number | null;
+    };
 }
 export interface FacetValue {
     id: string;
@@ -122,6 +176,11 @@ export interface Product {
     facetValues: FacetValue[];
     collections: CollectionRef[];
 }
+export interface RecommendedProductGroup {
+    groupName: string;
+    groupSlug: string;
+    products: ProductSummary[];
+}
 export interface ProductSummary {
     id: string;
     name: string;
@@ -136,10 +195,9 @@ export interface ProductSummary {
         priceWithTax: number;
         currencyCode: string;
         stockLevel: string;
-        priceListName: string | null;
-        retailPrice: number | null;
-        retailPriceWithTax: number | null;
-        priceTiers?: PriceTier[] | null;
+        b2bGroupName: string | null;
+        b2bRetailPrice: number | null;
+        b2bRetailPriceWithTax: number | null;
     }>;
     facetValues?: FacetValue[];
     collections?: CollectionRef[];
@@ -181,6 +239,10 @@ export interface CollectionDetail extends Collection {
             priceListName: string | null;
             retailPrice: number | null;
             retailPriceWithTax: number | null;
+            customFields: {
+                minOrderQuantity: number | null;
+                salesUnit: number | null;
+            };
         }>;
         totalItems: number;
     };
@@ -328,10 +390,50 @@ export interface RegisterInput {
     password: string;
     phoneNumber?: string;
 }
+export interface UpdateCustomerInput {
+    title?: string;
+    firstName: string;
+    lastName: string;
+    phoneNumber?: string;
+}
+export interface UpdateAddressInput {
+    id: string;
+    fullName?: string;
+    streetLine1?: string;
+    streetLine2?: string;
+    city?: string;
+    province?: string;
+    postalCode?: string;
+    countryCode?: string;
+    phoneNumber?: string;
+    company?: string;
+    defaultShippingAddress?: boolean;
+    defaultBillingAddress?: boolean;
+}
+export interface Country {
+    id: string;
+    code: string;
+    name: string;
+}
+export interface ActiveChannel {
+    id: string;
+    code: string;
+    defaultLanguageCode: string;
+    availableLanguageCodes: string[];
+    defaultCurrencyCode: string;
+    availableCurrencyCodes: string[];
+    customFields: Record<string, unknown>;
+}
+export interface FacetValueFilterInput {
+    and?: string;
+    or?: string[];
+}
 export interface SearchInput {
     term: string;
     collectionSlug?: string;
+    collectionId?: string;
     facetValueIds?: string[];
+    facetValueFilters?: FacetValueFilterInput[];
     take?: number;
     skip?: number;
     sort?: {
@@ -400,6 +502,42 @@ export interface OrderListOptions {
     take?: number;
     skip?: number;
 }
+export interface FavoriteVariant {
+    id: string;
+    name: string;
+    sku: string;
+    price: number;
+    priceWithTax: number;
+    currencyCode: string;
+    stockLevel: string;
+    priceListName: string | null;
+    retailPrice: number | null;
+    retailPriceWithTax: number | null;
+    priceTiers: PriceTier[] | null;
+    product: {
+        id: string;
+        name: string;
+        slug: string;
+        featuredAsset: Asset | null;
+    };
+    options: Array<{
+        id: string;
+        name: string;
+        group: {
+            name: string;
+        };
+    }>;
+    customFields: {
+        minOrderQuantity: number | null;
+        salesUnit: number | null;
+    };
+}
+export interface FavoriteItem {
+    id: string;
+    productVariantId: string;
+    createdAt: string;
+    productVariant: FavoriteVariant | null;
+}
 export interface PaginatedList<T> {
     items: T[];
     totalItems: number;
@@ -412,6 +550,43 @@ export interface ResolvedContent {
     }>;
     slug_translations?: Record<string, string>;
 }
+export interface SitemapEntry {
+    id: string;
+    path: string;
+    title: string | null;
+    collection_slug: string | null;
+    updated_at: string;
+    type?: 'collection_page';
+    language_code?: string;
+}
+export interface ContentItemSummary {
+    id: string;
+    slug: string | null;
+    status: string;
+    collection_id: string;
+    collection_name: string;
+    collection_title_field_slug: string | null;
+    title: string | null;
+}
+export interface ContentItemWithFields {
+    id: string;
+    title: string | null;
+    fieldValues: Record<string, unknown>;
+}
+export interface CollectionFieldDefinition {
+    id: string;
+    slug: string;
+    label: string;
+    fieldType: string;
+    position: number;
+    isRequired: boolean;
+    isLocalizable: boolean;
+    config: Record<string, unknown> | null;
+}
+export interface CollectionPageValues {
+    fields: CollectionFieldDefinition[];
+    values: Record<string, unknown>;
+}
 export interface ContentQueryOptions {
     collectionId?: string;
     collectionSlug?: string;
@@ -421,12 +596,6 @@ export interface ContentQueryOptions {
     sort?: string;
     languageCode?: string;
 }
-export interface AssetQueryOptions {
-    folderId?: string;
-    mimeType?: string;
-    limit?: number;
-    offset?: number;
-}
 export interface FormField {
     slug: string;
     label: string;
@@ -535,11 +704,66 @@ export interface OrderValidationResult {
     errors: OrderValidationError[];
 }
 export interface OrderValidationError {
-    type: 'min_amount' | 'min_quantity';
+    type: 'min_amount';
     message: string;
     required: number;
     actual: number;
 }
+export interface PropertyGroupTranslation {
+    id: string;
+    languageCode: string;
+    name: string;
+}
+export interface PropertyTranslation {
+    id: string;
+    languageCode: string;
+    name: string;
+    helpText: string | null;
+}
+export interface PropertyFieldFacet {
+    fieldSlug: string;
+    fieldType: string;
+    facetId: string;
+}
+export interface PropertyConfig {
+    options?: Array<{
+        value: string;
+        label: string;
+    }>;
+    min?: number;
+    max?: number;
+    maxLength?: number;
+    allowedCollectionIds?: string[];
+    filterableFieldSlugs?: string[];
+}
+export interface Property {
+    id: string;
+    slug: string;
+    fieldType: string;
+    isFilterable: boolean;
+    isRequired: boolean;
+    position: number;
+    config: PropertyConfig | null;
+    facetId: string | null;
+    fieldFacets: PropertyFieldFacet[];
+    translations: PropertyTranslation[];
+}
+export interface PropertyGroup {
+    id: string;
+    position: number;
+    translations: PropertyGroupTranslation[];
+    properties: Property[];
+}
+export interface PropertyValue {
+    id: string;
+    propertyId: string;
+    languageCode: string | null;
+    value: unknown;
+}
+export interface ProductPropertyGroupValues {
+    group: PropertyGroup;
+    values: PropertyValue[];
+}
 export type PresetName = 'xxs' | 'xs' | 's' | 'm' | 'l' | 'xl';
 export interface ResponsiveImageData {
     src: string;
@@ -549,12 +773,184 @@ export interface ResponsiveImageData {
     width: number;
     height: number;
 }
+export interface ReviewAttribute {
+    id: string;
+    slug: string;
+    label: string;
+    inputType: 'rating' | 'selection';
+    options: string[] | null;
+    isRequired: boolean;
+    section: 'product' | 'demographic';
+}
+export interface ProductReview {
+    id: string;
+    rating: number | null;
+    title: string | null;
+    body: string | null;
+    variantId: string | null;
+    customerDisplayName: string | null;
+    isVerifiedPurchase: boolean;
+    isEdited: boolean;
+    attributeValues: Record<string, number | string> | null;
+    imageAssetIds: string[] | null;
+    videoAssetIds: string[] | null;
+    helpfulCount: number;
+    notHelpfulCount: number;
+    merchantReply: string | null;
+    merchantReplyAt: string | null;
+    myVote: boolean | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ReviewRatingDistribution {
+    one: number;
+    two: number;
+    three: number;
+    four: number;
+    five: number;
+}
+export interface ReviewRatingSummary {
+    averageRating: number | null;
+    reviewCount: number;
+    ratingCount: number;
+    distribution: ReviewRatingDistribution;
+}
+export interface ReviewAttributeAggregation {
+    attributeId: string;
+    label: string;
+    inputType: string;
+    averageRating: number | null;
+    distribution: Record<string, number> | null;
+}
+export interface ReviewChannelConfig {
+    reviewsEnabled: boolean;
+    reviewsRequireText: boolean;
+    reviewsAllowMedia: boolean;
+    reviewsAllowVoting: boolean;
+    reviewsAllowRating: boolean;
+    reviewMinBodyLength: number;
+    reviewMaxTitleLength: number;
+    reviewMaxImages: number;
+    reviewMaxVideos: number;
+}
+export interface CreateReviewInput {
+    productId: string;
+    variantId?: string;
+    rating?: number;
+    title?: string;
+    body?: string;
+    imageAssetIds?: string[];
+    videoAssetIds?: string[];
+    attributeValues?: Record<string, number | string>;
+}
+export interface UpdateReviewInput {
+    rating?: number;
+    title?: string;
+    body?: string;
+    imageAssetIds?: string[];
+    videoAssetIds?: string[];
+    attributeValues?: Record<string, number | string>;
+}
+export interface ReviewListOptions {
+    take?: number;
+    cursor?: string;
+    sort?: 'NEWEST' | 'OLDEST' | 'HIGHEST_RATING' | 'LOWEST_RATING' | 'MOST_HELPFUL';
+    rating?: number;
+}
+export interface CreateReviewResult {
+    review: ProductReview;
+    requiresModeration: boolean;
+}
+export interface ReviewMediaUploadResult {
+    id: string;
+    preview: string;
+    mimeType: string;
+}
+export type CustomerSubscriptionStatus = 'TRIAL' | 'ACTIVE' | 'PAUSED' | 'PAST_DUE' | 'CANCELLED' | 'EXPIRED' | 'COMPLETED';
+export interface CustomerSubscription {
+    id: string;
+    planName: string;
+    currencyCode: string;
+    recurringPrice: number;
+    billingInterval: string;
+    currentStatus: CustomerSubscriptionStatus | null;
+    currentPeriodStart: string | null;
+    currentPeriodEnd: string | null;
+    nextRenewalAt: string | null;
+    cancelAtPeriodEnd: boolean;
+    createdAt: string;
+}
+export interface VatValidationResult {
+    status: string;
+    vatNumber: string;
+    countryCode: string;
+    companyName: string | null;
+    companyAddress: string | null;
+    validatedAt: string | null;
+    error: string | null;
+}
+export interface DropOffPointInput {
+    postalCode: string;
+    countryCode?: string;
+    carrierId?: string;
+}
+export interface DropOffPoint {
+    locationCode: string;
+    locationName: string;
+    street: string;
+    number: string;
+    numberSuffix: string | null;
+    postalCode: string;
+    city: string;
+    countryCode: string;
+    phone: string | null;
+    reference: string | null;
+    longitude: string | null;
+    latitude: string | null;
+    availableDays: number[] | null;
+    cutOffTime: string | null;
+    carrierId: number | null;
+    distance: number | null;
+}
+export interface DeliveryOptionsInput {
+    postalCode: string;
+    countryCode?: string;
+    carrierId?: number;
+    deliveryDate?: string;
+    cutoffTime?: string;
+    mondayDelivery?: boolean;
+    saturdayDelivery?: boolean;
+    dropoffDays?: string;
+}
+export interface DeliveryTimeFrame {
+    start: string;
+    end: string;
+    priceComment: string | null;
+}
+export interface DeliveryOption {
+    date: string;
+    time: DeliveryTimeFrame[];
+}
+export interface ShipmentTrackingHistoryEntry {
+    status: number;
+    time: string;
+}
+export interface ShipmentTrackingInfo {
+    shipmentId: number;
+    status: {
+        current: number;
+        final: boolean;
+    };
+    history: ShipmentTrackingHistoryEntry[];
+    barcode: string;
+    consumerPortalLink: string | null;
+}
 export interface CommerceModule {
-    getProduct(slug: string): Promise<Product>;
-    getProductById(id: string): Promise<Product>;
-    getProducts(options?: ProductListOptions): Promise<PaginatedList<ProductSummary>>;
-    getFacets(): Promise<Facet[]>;
-    searchProducts(input: SearchInput): Promise<SearchResult>;
+    getProduct(slug: string, options?: RequestOptions): Promise<Product>;
+    getProductById(id: string, options?: RequestOptions): Promise<Product>;
+    getProducts(listOptions?: ProductListOptions, options?: RequestOptions): Promise<PaginatedList<ProductSummary>>;
+    getFacets(options?: RequestOptions): Promise<Facet[]>;
+    searchProducts(input: SearchInput, options?: RequestOptions): Promise<SearchResult>;
     getActiveOrder(): Promise<Order | null>;
     addToCart(variantId: string, quantity: number): Promise<Order>;
     updateCartLine(lineId: string, quantity: number): Promise<Order>;
@@ -579,23 +975,85 @@ export interface CommerceModule {
     logout(): Promise<void>;
     getCurrentCustomer(): Promise<Customer | null>;
     getCustomerOrders(options?: OrderListOptions): Promise<PaginatedList<OrderSummary>>;
-    getCollections(options?: CollectionListOptions): Promise<Collection[]>;
-    getCollection(slug: string): Promise<CollectionDetail>;
+    getCollections(listOptions?: CollectionListOptions, options?: RequestOptions): Promise<Collection[]>;
+    getCollection(slug: string, options?: RequestOptions): Promise<CollectionDetail>;
+    updateCustomer(input: UpdateCustomerInput): Promise<Customer>;
+    updatePassword(currentPassword: string, newPassword: string): Promise<void>;
+    requestPasswordReset(emailAddress: string): Promise<void>;
+    resetPassword(token: string, password: string): Promise<{
+        id: string;
+        identifier: string;
+    }>;
+    requestEmailUpdate(password: string, newEmailAddress: string): Promise<void>;
+    updateEmail(token: string): Promise<void>;
+    verifyAccount(token: string, password?: string): Promise<{
+        id: string;
+        identifier: string;
+    }>;
+    refreshVerification(emailAddress: string): Promise<void>;
+    createAddress(input: AddressInput): Promise<CustomerAddress>;
+    updateAddress(input: UpdateAddressInput): Promise<CustomerAddress>;
+    deleteAddress(id: string): Promise<void>;
+    getAvailableCountries(): Promise<Country[]>;
+    getOrderByCode(code: string): Promise<Order>;
+    getActiveChannel(): Promise<ActiveChannel>;
+    getPropertyGroups(options?: RequestOptions): Promise<PropertyGroup[]>;
+    getProductProperties(productId: string, options?: RequestOptions): Promise<ProductPropertyGroupValues[]>;
+    getFavoriteVariantIds(): Promise<string[]>;
+    getMyFavorites(options?: {
+        take?: number;
+        skip?: number;
+    }): Promise<PaginatedList<FavoriteItem>>;
+    toggleFavorite(productVariantId: string): Promise<boolean>;
+    removeFavorite(productVariantId: string): Promise<boolean>;
+    getProductRecommendations(productId: string, groupSlug?: string): Promise<RecommendedProductGroup[]>;
+    getAgeVerificationStatus(): Promise<AgeVerificationStatus>;
+    submitDateOfBirth(dateOfBirth: string): Promise<AgeVerificationStatus>;
+    confirmAge(): Promise<AgeVerificationStatus>;
+    getProductReviews(productId: string, options?: ReviewListOptions): Promise<{
+        items: ProductReview[];
+        totalItems: number;
+        nextCursor: string | null;
+    }>;
+    getReviewRatingSummary(productId: string): Promise<ReviewRatingSummary>;
+    getReviewAttributeAggregations(productId: string): Promise<ReviewAttributeAggregation[]>;
+    getReviewAttributes(productId?: string): Promise<ReviewAttribute[]>;
+    getMyReview(productId: string): Promise<ProductReview | null>;
+    getReviewChannelConfig(): Promise<ReviewChannelConfig>;
+    createReview(input: CreateReviewInput): Promise<CreateReviewResult>;
+    updateReview(id: string, input: UpdateReviewInput): Promise<ProductReview>;
+    deleteReview(id: string): Promise<boolean>;
+    voteReview(reviewId: string, isHelpful: boolean): Promise<boolean>;
+    reportReview(reviewId: string, reason: string): Promise<boolean>;
+    uploadReviewMedia(files: File[]): Promise<ReviewMediaUploadResult[]>;
+    getMySubscriptions(): Promise<CustomerSubscription[]>;
+    getMyVatValidationStatus(): Promise<VatValidationResult | null>;
+    setMyVatNumber(vatNumber: string): Promise<VatValidationResult>;
+    clearMyVatNumber(): Promise<boolean>;
+    getDropOffPoints(input: DropOffPointInput): Promise<DropOffPoint[]>;
+    getDeliveryOptions(input: DeliveryOptionsInput): Promise<DeliveryOption[]>;
+    trackShipment(barcode: string, postalCode: string): Promise<ShipmentTrackingInfo | null>;
 }
 export interface ContentModule {
-    resolvePath(path: string, locale?: string): Promise<ResolvedContent>;
-    getContent(options: ContentQueryOptions): Promise<Record<string, unknown>>;
-    getAssets(options?: AssetQueryOptions): Promise<Record<string, unknown>>;
-    getForm(id: string): Promise<FormDefinition>;
+    resolvePath(path: string, locale?: string, options?: RequestOptions): Promise<ResolvedContent>;
+    getContent(queryOptions: ContentQueryOptions, options?: RequestOptions): Promise<Record<string, unknown>>;
+    getAsset(id: string, options?: RequestOptions): Promise<CmsAsset>;
+    lookupAssets(ids: string[], options?: RequestOptions): Promise<CmsAsset[]>;
+    lookupVendureAssetDescriptions(vendureAssetIds: string[], options?: RequestOptions): Promise<Record<string, VendureAssetDescriptionTranslation[]>>;
+    getForm(id: string, options?: RequestOptions): Promise<FormDefinition>;
     submitForm(id: string, values: Record<string, unknown>): Promise<FormSubmissionResult>;
-    getContentStrings(format?: 'list' | 'export'): Promise<ContentStrings>;
-    getMenus(): Promise<Menu[]>;
-    getMenu(slugOrId: string): Promise<Menu>;
+    getContentStrings(format?: 'list' | 'export', options?: RequestOptions): Promise<ContentStrings>;
+    getMenus(options?: RequestOptions): Promise<Menu[]>;
+    getMenu(slugOrId: string, options?: RequestOptions): Promise<Menu>;
+    getSitemap(languageCode?: string, options?: RequestOptions): Promise<SitemapEntry[]>;
+    lookupContentItems(ids: string[], options?: RequestOptions): Promise<ContentItemSummary[]>;
+    lookupContentItemsWithFields(ids: string[], fieldSlugs: string[], options?: RequestOptions): Promise<ContentItemWithFields[]>;
+    getCollectionPageValues(collectionId: string, languageCode?: string, options?: RequestOptions): Promise<CollectionPageValues>;
 }
 export interface NavigationModule {
-    getRoutes(languageCode?: string): Promise<RoutesResponse>;
-    findRoute(path: string, languageCode?: string): Promise<RouteEntry | null>;
-    getRoutesByType(type: 'cms' | 'collection' | 'product', languageCode?: string): Promise<RouteEntry[]>;
+    getRoutes(languageCode?: string, options?: RequestOptions): Promise<RoutesResponse>;
+    findRoute(path: string, languageCode?: string, options?: RequestOptions): Promise<RouteEntry | null>;
+    getRoutesByType(type: 'cms' | 'collection' | 'product', languageCode?: string, options?: RequestOptions): Promise<RouteEntry[]>;
 }
 export interface PricingModule {
     formatPrice(amount: number, currencyCode?: string, locale?: string): string;
@@ -605,11 +1063,9 @@ export interface PricingModule {
     getPriceDisplay(variant: VariantPriceData): PriceDisplay;
     validateOrderMinimums(order: {
         totalWithTax: number;
-        totalQuantity: number;
         currencyCode: string;
     }, constraints: {
         minOrderAmount?: number;
-        minOrderQuantity?: number;
     }): OrderValidationResult;
 }
 export interface MediaModule {
@@ -629,6 +1085,7 @@ export interface StorefrontClient {
     readonly pricing: PricingModule;
     readonly media: MediaModule;
     readonly currency: CurrencyModule;
+    readonly maintenanceMode: boolean;
     setLanguage(code: string): void;
     getLanguage(): string;
     setAuthToken(token: string): void;