@behio/storefront-sdk 0.38.0 → 0.41.0

package/dist/{client-Cb_eHKm9.d.mts → client-sN7fZvjG.d.mts}

@@ -339,6 +339,31 @@ interface ProductListItem {
     /** `null` when prices are gated behind login for guests (B2B mode). */
     price: ProductPrice | null;
     inStock: boolean;
+    /**
+     * Launch okno: sale window opens at this time (epoch ms); null/undefined =
+     * on sale since publish. Before it the product is visible but NOT
+     * purchasable — render a "Prodej startuje za ..." countdown instead of the
+     * buy button.
+     */
+    saleStartAt?: number | null;
+    /** Sale window closes at this time (epoch ms); null/undefined = never closes. */
+    saleEndAt?: number | null;
+    /**
+     * Server-resolved "can this be bought RIGHT NOW": the sale window is open
+     * AND the product can be ordered (in stock, or the shop sells beyond
+     * stock). The cart/checkout enforce the same rule server-side — use this to
+     * disable the buy button, never re-derive the rule client-side.
+     */
+    isPurchasable: boolean;
+    /**
+     * Early bird (time-based launch price) is active: `price.amount` already IS
+     * the discounted early-bird amount and the regular price sits in
+     * `price.compareAtPrice`. Applies in the eshop default currency only.
+     */
+    earlyBirdActive: boolean;
+    /** When the active early bird ends (epoch ms) — render "Early bird do ...".
+     *  Null when no early bird is active. */
+    earlyBirdUntil?: number | null;
     /** Exact remaining stock, or `null` when the merchant hides the count
      *  (showStockCount off) — treat null as "unknown", never as 0. */
     stockQuantity?: number | null;
@@ -404,7 +429,7 @@ interface ProductPromotionSummary {
     badgeText: string | null;
     /** Merchant hex badge color; null falls back to the shop's sale color. */
     badgeColor: string | null;
-    discountType: 'PERCENTAGE' | 'FIXED_AMOUNT' | 'BUY_X_GET_Y';
+    discountType: "PERCENTAGE" | "FIXED_AMOUNT" | "BUY_X_GET_Y";
     discountValue: number;
     /** Promotion end (epoch ms), or null for open-ended. */
     endsAt: number | null;
@@ -413,8 +438,8 @@ interface ProductPromotionSummary {
 }
 /** A single responsive derivative (size + format) of a media image. */
 interface ProductMediaVariant {
-    variant: 'thumb' | 'medium' | 'large' | 'xlarge';
-    format: 'jpeg' | 'webp' | 'avif';
+    variant: "thumb" | "medium" | "large" | "xlarge";
+    format: "jpeg" | "webp" | "avif";
     url: string;
     width: number;
     height: number;
@@ -427,7 +452,7 @@ interface ProductMediaVariant {
  */
 interface ProductMedia {
     id: string;
-    type: 'IMAGE' | 'VIDEO';
+    type: "IMAGE" | "VIDEO";
     /** Original uploaded file URL. */
     url: string;
     alt?: string | null;
@@ -452,7 +477,7 @@ interface VariantAxisValue {
  */
 interface VariantAxis {
     name: string;
-    displayType: 'DROPDOWN' | 'BUTTON' | 'SWATCH_COLOR' | 'SWATCH_IMAGE';
+    displayType: "DROPDOWN" | "BUTTON" | "SWATCH_COLOR" | "SWATCH_IMAGE";
     order: number;
     /** Values present among the purchasable variants, in admin-defined order. */
     values: VariantAxisValue[];
@@ -1122,6 +1147,11 @@ interface CourseListItem {
     /** Access expiry (epoch ms, null = never expires). */
     expiresAt: number | null;
     isExpired: boolean;
+    /**
+     * Course content opens at this time (epoch ms); null/undefined = already
+     * open. While in the future, render "Startujeme ..." + countdown.
+     */
+    contentAvailableFrom?: number | null;
 }
 /** Downloadable attachment on a course lesson. */
 interface CourseAttachment {
@@ -1145,6 +1175,11 @@ interface CourseLesson {
     videoUrl: string | null;
     content: string | null;
     attachments: CourseAttachment[];
+    /**
+     * Number of quiz questions on this lesson (0 = no quiz). Load the quiz via
+     * `customer.getLessonQuiz()` once the lesson is unlocked.
+     */
+    quizQuestionCount: number;
 }
 interface CourseModule {
     id: string;
@@ -1159,11 +1194,37 @@ interface CourseDetail {
     imageUrl: string | null;
     /** Welcome text shown at the top of the member area (markdown). */
     welcomeText: string | null;
+    /**
+     * AI tutor ("Ask about this lesson") is available on unlocked lessons —
+     * render the tutor widget only when true.
+     */
+    aiTutorEnabled: boolean;
+    /**
+     * Lesson discussion (comments) is available on unlocked lessons — render
+     * the discussion widget only when true.
+     */
+    discussionEnabled: boolean;
+    /**
+     * Course content opens at this time (epoch ms); null/undefined = already
+     * open. While in the future EVERY lesson (including previews) is locked
+     * with `unlockAt >= contentAvailableFrom` — render "Startujeme ..." +
+     * countdown in the member area.
+     */
+    contentAvailableFrom?: number | null;
     enrolledAt: number;
     expiresAt: number | null;
     totalLessons: number;
     completedLessons: number;
     modules: CourseModule[];
+    /**
+     * Completion certificate, present once the course is 100 % finished and the
+     * merchant has certificates enabled. Verify the code publicly via
+     * `certificates.verify(code)`.
+     */
+    certificate?: {
+        code: string;
+        issuedAt: number;
+    } | null;
 }
 /** Progress snapshot returned after completing a lesson. */
 interface CourseProgress {
@@ -1172,6 +1233,142 @@ interface CourseProgress {
     totalLessons: number;
     completedLessons: number;
 }
+/** One quiz question. Correct answers are never exposed before submitting. */
+interface QuizQuestion {
+    id: string;
+    question: string;
+    /** Option texts in order; submit the chosen option's index. */
+    options: string[];
+}
+interface LessonQuiz {
+    courseId: string;
+    lessonId: string;
+    /** Minimum score (in %) that completes the lesson automatically. */
+    passPercent: number;
+    questions: QuizQuestion[];
+}
+interface QuizAnswerInput {
+    questionId: string;
+    /** Index of the chosen option (0-based). */
+    selectedIndex: number;
+}
+interface QuizAnswerResult {
+    questionId: string;
+    /** Echo of the submitted choice; null when unanswered or out of range. */
+    selectedIndex: number | null;
+    /** Correct option index, revealed only after submitting. */
+    correctIndex: number;
+    correct: boolean;
+}
+interface QuizResult {
+    courseId: string;
+    lessonId: string;
+    totalQuestions: number;
+    correctCount: number;
+    scorePercent: number;
+    passPercent: number;
+    passed: boolean;
+    /** True when the passing score marked the lesson completed. */
+    lessonCompleted: boolean;
+    results: QuizAnswerResult[];
+    /** Course progress after a passing submit; null when not passed. */
+    progress: {
+        totalLessons: number;
+        completedLessons: number;
+    } | null;
+}
+/** One exchange in the private AI tutor thread: question + answer. */
+interface CourseTutorMessage {
+    id: string;
+    /** The student's question. */
+    question: string;
+    /** The AI tutor's answer (plain text / light markdown). */
+    answer: string;
+    createdAt: number;
+}
+/** The student's private tutor thread for one lesson. */
+interface CourseTutorThread {
+    courseId: string;
+    lessonId: string;
+    /** False when the merchant disabled the AI tutor — hide the widget. */
+    enabled: boolean;
+    /** Oldest first. */
+    items: CourseTutorMessage[];
+}
+/** A one-level reply under a top-level lesson comment. */
+interface CourseCommentReply {
+    id: string;
+    /** Id of the parent (top-level) comment. */
+    parentId: string;
+    body: string;
+    /** Author's first name, or a masked e-mail when no name is known. */
+    authorName: string;
+    /** True when the logged-in customer wrote this reply (can delete it). */
+    isMine: boolean;
+    createdAt: number;
+}
+/** A top-level comment under a lesson, with one level of replies. */
+interface CourseComment {
+    id: string;
+    body: string;
+    /** Author's first name, or a masked e-mail when no name is known. */
+    authorName: string;
+    /** True when the logged-in customer wrote this comment (can delete it). */
+    isMine: boolean;
+    createdAt: number;
+    /** Oldest first. */
+    replies: CourseCommentReply[];
+}
+/** Paginated lesson discussion (top-level comments, newest first). */
+interface CourseCommentsList {
+    courseId: string;
+    lessonId: string;
+    /** False when the merchant disabled the discussion — hide the widget. */
+    enabled: boolean;
+    /** 1-based page of top-level comments. */
+    page: number;
+    pageSize: number;
+    /** Total count of top-level comments on the lesson. */
+    totalCount: number;
+    items: CourseComment[];
+}
+/** The comment (or reply) just posted by the logged-in customer. */
+interface CoursePostedComment {
+    id: string;
+    /** Id of the parent comment when this is a reply; null for top-level. */
+    parentId?: string | null;
+    body: string;
+    authorName: string;
+    isMine: boolean;
+    createdAt: number;
+}
+/** The student's private note for one lesson (visible only to them). */
+interface LessonNote {
+    courseId: string;
+    lessonId: string;
+    /** The note text; empty string when no note exists yet. */
+    body: string;
+    /** Last save time (epoch ms); null when no note exists yet. */
+    updatedAt: number | null;
+}
+/** One completion certificate on the customer's account. */
+interface CourseCertificate {
+    courseId: string;
+    courseName: string | null;
+    /** Public verification code (share it, verify via `certificates.verify`). */
+    code: string;
+    issuedAt: number;
+}
+/** Public verification payload for a certificate code. */
+interface CertificateVerification {
+    valid: boolean;
+    code: string;
+    courseId: string;
+    courseName: string | null;
+    /** Student's name, or a masked e-mail when no name is known. */
+    studentName: string;
+    issuedAt: number;
+}
 /** Short-lived signed URL to fetch a purchased digital file. */
 interface DownloadUrl {
     /** Short-lived (15 min) signed URL. */
@@ -1876,6 +2073,7 @@ declare class BehioStorefront {
     readonly shipping: ShippingModule;
     readonly newsletter: NewsletterModule;
     readonly subscriptions: SubscriptionsModule;
+    readonly certificates: CourseCertificatesModule;
     /**
      * Called by the analytics tracker when the visitor grants (id) or revokes
      * (null) analytics consent. When set, requests carry the X-Behio-Vid header
@@ -2006,6 +2204,13 @@ declare class BehioStorefront {
         signal?: AbortSignal;
         headers?: Record<string, string>;
     }): Promise<SdkResult<T>>;
+    /**
+     * Binary GET (PDF downloads). Same auth headers as `request()`, but the
+     * response is returned as a Blob instead of parsed JSON.
+     *
+     * @internal — use the typed module methods (behio.certificates.downloadPdf).
+     */
+    requestBlob(path: string): Promise<SdkResult<Blob>>;
     /**
      * Throws on failure (API error / network / timeout). Kept private so
      * internal auth refresh recursion keeps its existing control flow —
@@ -2298,6 +2503,77 @@ declare class CustomerModule {
     getCourse(courseId: string): Promise<SdkResult<CourseDetail>>;
     /** Mark an unlocked lesson as completed (idempotent). */
     completeLesson(courseId: string, lessonId: string): Promise<SdkResult<CourseProgress>>;
+    /**
+     * Quiz for an unlocked lesson. Correct answers are never included — scoring
+     * happens server-side in `submitLessonQuiz`. Locked lessons return 403.
+     */
+    getLessonQuiz(courseId: string, lessonId: string): Promise<SdkResult<LessonQuiz>>;
+    /**
+     * Submit quiz answers: returns the score, reveals correct answers and, when
+     * the score reaches `passPercent` (70 %), marks the lesson completed
+     * automatically.
+     */
+    submitLessonQuiz(courseId: string, lessonId: string, answers: QuizAnswerInput[]): Promise<SdkResult<QuizResult>>;
+    /**
+     * Completion certificates of the logged-in customer. Each carries a public
+     * verification code for sharing (LinkedIn, CV).
+     */
+    getCourseCertificates(): Promise<SdkResult<{
+        items: CourseCertificate[];
+    }>>;
+    /**
+     * AI tutor "Ask about this lesson": the student's private thread for one
+     * lesson (oldest first). `enabled: false` = the merchant turned the tutor
+     * off — hide the widget. Locked lessons return 403.
+     */
+    getLessonTutorThread(courseId: string, lessonId: string): Promise<SdkResult<CourseTutorThread>>;
+    /**
+     * Ask the AI tutor a question about the lesson. The answer sticks to the
+     * lesson topic and comes back in the language of the question (Czech by
+     * default). Rate limited (20/min); 403 on locked lessons or when the
+     * merchant disabled the tutor.
+     */
+    askLessonTutor(courseId: string, lessonId: string, question: string): Promise<SdkResult<CourseTutorMessage>>;
+    /**
+     * Lesson discussion: paginated top-level comments (newest first) with one
+     * level of replies. Only enrolled customers with the lesson unlocked; 403
+     * when the merchant disabled the discussion.
+     */
+    getLessonComments(courseId: string, lessonId: string, page?: number): Promise<SdkResult<CourseCommentsList>>;
+    /**
+     * Post a comment under the lesson, or a reply when `parentId` points to a
+     * top-level comment (replies go one level deep only). Max 5000 characters.
+     */
+    postLessonComment(courseId: string, lessonId: string, body: string, parentId?: string): Promise<SdkResult<CoursePostedComment>>;
+    /**
+     * Delete the customer's OWN comment (including its replies). Someone
+     * else's comment returns 404.
+     */
+    deleteLessonComment(courseId: string, lessonId: string, commentId: string): Promise<SdkResult<void>>;
+    /**
+     * The student's private note for one lesson. `body` is an empty string
+     * when no note exists yet. Visible only to the logged-in student.
+     */
+    getLessonNote(courseId: string, lessonId: string): Promise<SdkResult<LessonNote>>;
+    /**
+     * Save (upsert) the student's private lesson note. Autosave-friendly; an
+     * empty string clears the note. Max 20 000 characters.
+     */
+    saveLessonNote(courseId: string, lessonId: string, body: string): Promise<SdkResult<LessonNote>>;
+}
+declare class CourseCertificatesModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /**
+     * Publicly verify a certificate code (no customer login needed) — build a
+     * `/certifikat/{code}` page with this. Unknown codes return a 404 error.
+     */
+    verify(code: string): Promise<SdkResult<CertificateVerification>>;
+    /**
+     * Download the certificate as a branded PDF (A5 landscape). Returns a Blob;
+     * trigger a browser download via `URL.createObjectURL(blob)`.
+     */
+    downloadPdf(code: string): Promise<SdkResult<Blob>>;
 }
 declare class PagesModule {
     private client;
@@ -2488,4 +2764,4 @@ declare class NewsletterModule {
     unsubscribe(email: string): Promise<SdkResult<NewsletterUnsubscribeResult>>;
 }
 
-export { type ReturnRequest as $, type AddressSuggestion as A, type BehioStorefrontConfig as B, type Category as C, type CheckoutInput as D, type PageDetail as E, type FilterField as F, type Page as G, type ShopInfo as H, type ShopScripts as I, type ShopSeo as J, type Bundle as K, type LoyaltySummary as L, type Menu as M, type NewsletterSubscribeResult as N, type OrderListItem as O, type ProductsQuery as P, type ProductGroup as Q, type RegisterInput as R, type Subscription as S, type CrossSellItem as T, type ActivePromotion as U, type GiftCardBalance as V, type WishlistItem as W, type ProductReviewsResponse as X, type SubmitReviewInput as Y, type ReturnableOrder as Z, type ReturnStatus as _, BehioStorefront as a, type OrderStatusHistory as a$, type SubmitReturnInput as a0, type CookieConsent as a1, type CookieConsentInput as a2, type QuoteRequest as a3, type SubmitQuoteInput as a4, type BackInStockSubscription as a5, type AddToCartInput as a6, type AuthTokens as a7, BehioApiError as a8, type BundleItem as a9, type CourseLesson as aA, type CourseModule as aB, type DataGroupFieldType as aC, type DigitalDownload as aD, type DownloadUrl as aE, type Facet as aF, type FacetAvailability as aG, type FacetCategory as aH, type FacetLabel as aI, type FacetPriceRange as aJ, type FacetRange as aK, type FacetRatingBucket as aL, type FacetValue as aM, FulfillmentStatuses as aN, type GiftCardPurchaseInput as aO, type GiftCardPurchaseResult as aP, type GiftCardSummary as aQ, type LoyaltyBalance as aR, type LoyaltyNextTier as aS, type LoyaltyProgram as aT, type LoyaltyTier as aU, type LoyaltyTierPerks as aV, type LoyaltyTransaction as aW, type MenuItem as aX, type MenuItemRef as aY, type MenuItemType as aZ, type NewsletterOptInDefault as a_, type CartDiscount as aa, type CartItem as ab, type CheckoutAddress as ac, type FulfillmentStatus as ad, type LoginInput as ae, type MessageResponse as af, type OrderItem as ag, type OrderStatus as ah, type PaymentStatus as ai, type ProductPrice as aj, type ProductReview as ak, type ProductVariant as al, type SdkResult as am, type AddressType as an, AddressTypes as ao, type BadgeTone as ap, type BehioErrorCode as aq, type BehioEventHandler as ar, type BehioEventType as as, BehioNetworkError as at, type CartBundleLine as au, type CartBundleLineItem as av, type CartItemProduct as aw, type CartPromotion as ax, type CheckoutSettings as ay, type CourseAttachment as az, type PaginatedResponse as b, OrderStatuses as b0, type OrderTracking as b1, type PageAttachment as b2, PaymentStatuses as b3, type PickupPointHours as b4, type PriceDisplay as b5, type ProductAvailability as b6, type ProductCustomField as b7, type ProductCustomFieldGroup as b8, type ProductMedia as b9, type VariantAxisValue as bA, err as bB, ok as bC, toSdkError as bD, type ProductMediaVariant as ba, type ProductPromotionSummary as bb, ProductSort as bc, type ProductSortValue as bd, type ProductVolumePrice as be, type QuoteItem as bf, type RegisterResult as bg, type RequestInterceptor as bh, type RequestInterceptorConfig as bi, type ResponseInterceptor as bj, type ResponseInterceptorData as bk, type ReturnRequestItem as bl, type ReturnStatusItem as bm, type ReturnableOrderItem as bn, type SdkError as bo, type ShopScript as bp, type ShopScriptPlacement as bq, type ShopScriptType as br, type ShopSeoIdentity as bs, type StockBehavior as bt, type StockMode as bu, type SubscriptionFrequency as bv, type SubscriptionItem as bw, type SubscriptionStatus as bx, type TaxBreakdownLine as by, type VariantAxis as bz, type ProductListItem as c, type ProductDetail as d, type CategoryDetail as e, type ProductLabel as f, type FacetsResponse as g, type Cart as h, type CustomerProfile as i, type CustomerAddress as j, type AddressDetail as k, type CourseDetail as l, type CourseProgress as m, type CourseListItem as n, type SubscriptionAction as o, type PickupPointsInput as p, type PickupPoint as q, type ShippingMethodSummary as r, type ShippingQuoteInput as s, type ShippingQuote as t, type CheckoutPaymentMethod as u, type NewsletterSubscribeInput as v, type NewsletterUnsubscribeResult as w, type OrderDetail as x, type OrderAccessRequestResponse as y, type OrderAccessVerifyResponse as z };
+export { type DownloadUrl as $, type ActivePromotion as A, BehioStorefront as B, type CookieConsent as C, type CheckoutAddress as D, type CheckoutInput as E, type CheckoutPaymentMethod as F, type CheckoutSettings as G, type CookieConsentInput as H, type CourseAttachment as I, type CourseCertificate as J, type CourseComment as K, type CourseCommentReply as L, type CourseCommentsList as M, type CourseDetail as N, type CourseLesson as O, type CourseListItem as P, type CourseModule as Q, type CoursePostedComment as R, type SdkResult as S, type CourseProgress as T, type CourseTutorMessage as U, type CourseTutorThread as V, type CrossSellItem as W, type CustomerAddress as X, type CustomerProfile as Y, type DataGroupFieldType as Z, type DigitalDownload as _, type AddToCartInput as a, type ProductPrice as a$, type Facet as a0, type FacetAvailability as a1, type FacetCategory as a2, type FacetLabel as a3, type FacetPriceRange as a4, type FacetRange as a5, type FacetRatingBucket as a6, type FacetValue as a7, type FacetsResponse as a8, type FilterField as a9, type OrderAccessVerifyResponse as aA, type OrderDetail as aB, type OrderItem as aC, type OrderListItem as aD, type OrderStatus as aE, type OrderStatusHistory as aF, OrderStatuses as aG, type OrderTracking as aH, type Page as aI, type PageAttachment as aJ, type PageDetail as aK, type PaginatedResponse as aL, type PaymentStatus as aM, PaymentStatuses as aN, type PickupPoint as aO, type PickupPointHours as aP, type PickupPointsInput as aQ, type PriceDisplay as aR, type ProductAvailability as aS, type ProductCustomField as aT, type ProductCustomFieldGroup as aU, type ProductDetail as aV, type ProductGroup as aW, type ProductLabel as aX, type ProductListItem as aY, type ProductMedia as aZ, type ProductMediaVariant as a_, type FulfillmentStatus as aa, FulfillmentStatuses as ab, type GiftCardBalance as ac, type GiftCardPurchaseInput as ad, type GiftCardPurchaseResult as ae, type GiftCardSummary as af, type LessonNote as ag, type LessonQuiz as ah, type LoginInput as ai, type LoyaltyBalance as aj, type LoyaltyNextTier as ak, type LoyaltyProgram as al, type LoyaltySummary as am, type LoyaltyTier as an, type LoyaltyTierPerks as ao, type LoyaltyTransaction as ap, type Menu as aq, type MenuItem as ar, type MenuItemRef as as, type MenuItemType as at, type MessageResponse as au, type NewsletterOptInDefault as av, type NewsletterSubscribeInput as aw, type NewsletterSubscribeResult as ax, type NewsletterUnsubscribeResult as ay, type OrderAccessRequestResponse as az, type AddressDetail as b, type ProductPromotionSummary as b0, type ProductReview as b1, type ProductReviewsResponse as b2, ProductSort as b3, type ProductSortValue as b4, type ProductVariant as b5, type ProductVolumePrice as b6, type ProductsQuery as b7, type QuizAnswerInput as b8, type QuizAnswerResult as b9, type ShopSeoIdentity as bA, type StockBehavior as bB, type StockMode as bC, type SubmitQuoteInput as bD, type SubmitReturnInput as bE, type SubmitReviewInput as bF, type Subscription as bG, type SubscriptionAction as bH, type SubscriptionFrequency as bI, type SubscriptionItem as bJ, type SubscriptionStatus as bK, type TaxBreakdownLine as bL, type VariantAxis as bM, type VariantAxisValue as bN, type WishlistItem as bO, err as bP, ok as bQ, toSdkError as bR, type QuizQuestion as ba, type QuizResult as bb, type QuoteItem as bc, type QuoteRequest as bd, type RegisterInput as be, type RegisterResult as bf, type RequestInterceptor as bg, type RequestInterceptorConfig as bh, type ResponseInterceptor as bi, type ResponseInterceptorData as bj, type ReturnRequest as bk, type ReturnRequestItem as bl, type ReturnStatus as bm, type ReturnStatusItem as bn, type ReturnableOrder as bo, type ReturnableOrderItem as bp, type SdkError as bq, type ShippingMethodSummary as br, type ShippingQuote as bs, type ShippingQuoteInput as bt, type ShopInfo as bu, type ShopScript as bv, type ShopScriptPlacement as bw, type ShopScriptType as bx, type ShopScripts as by, type ShopSeo as bz, type AddressSuggestion as c, type AddressType as d, AddressTypes as e, type AuthTokens as f, type BackInStockSubscription as g, type BadgeTone as h, BehioApiError as i, type BehioErrorCode as j, type BehioEventHandler as k, type BehioEventType as l, BehioNetworkError as m, type BehioStorefrontConfig as n, type Bundle as o, type BundleItem as p, type Cart as q, type CartBundleLine as r, type CartBundleLineItem as s, type CartDiscount as t, type CartItem as u, type CartItemProduct as v, type CartPromotion as w, type Category as x, type CategoryDetail as y, type CertificateVerification as z };