@ikas/bp-storefront 1.4.0-beta.23 → 1.4.0-beta.230

package/dist/storefront-config/src/theme-globals.d.ts

@@ -0,0 +1,349 @@
+export declare function cssVarCamelCase(str: string): string;
+/**
+ * Shared "theme globals" contract — the serialized, runtime-readable form of the editor's
+ * global theme settings (the left "Styles" panel): global variables + design tokens
+ * (colors, typography, breakpoints, keyframes, color schemes).
+ *
+ * This is packed into `IkasStorefrontConfig.themeGlobals` and read by the
+ * `@ikas/bp-storefront` runtime API (getThemeSetting / getThemeColors / ...). The same
+ * payload is produced for SSR, client hydration, and the editor canvas via
+ * {@link serializeThemeGlobals}, and returned by the CLI/MCP `list-theme-globals` reader.
+ */
+/** Global-variable value kinds, mirrored from the editor sidebar `GlobalVariableType`. */
+export type GlobalVariableType = "TEXT" | "RICH_TEXT" | "IMAGE" | "COLOR" | "NUMBER" | "BOOLEAN" | "BORDER" | "SHADOW" | "ENUM";
+/** A theme "global variable" (Theme Settings panel). `name` is the stable runtime key. */
+export type ThemeSetting = {
+    /** Stable runtime key — the variable's `variableName` (e.g. `_6Q0KV7VGGM`). */
+    name: string;
+    /** Human-facing label. */
+    displayName: string;
+    type: GlobalVariableType;
+    /**
+     * Concrete value, discriminated by `type`:
+     * - TEXT/RICH_TEXT → string · NUMBER → number · BOOLEAN → boolean · COLOR → hex string.
+     * - IMAGE → an IkasImage REFERENCE, e.g. `{ id: "theme-images/<uuid>" }`. It has NO
+     *   `.url` field — resolve to a URL with `getDefaultSrc(value)` / `getSrc(value, size)`
+     *   from `@ikas/bp-storefront`, never read `value.url`.
+     * - BORDER/SHADOW → object, or `null` when unset.
+     * - ENUM → the selected option VALUE string (one of `Object.values(options)`, never a label),
+     *   or `null` when unset or when that option no longer exists on the enum.
+     */
+    value: any;
+    /**
+     * ENUM only — id of the project enum type (`project.types[].id`) this setting selects from. It is
+     * the same id an ENUM component prop carries as `enumTypeId`; matching ids are what make a prop
+     * bindable to the setting.
+     */
+    enumTypeId?: string;
+    /**
+     * ENUM only — the enum's options at serialize time, `{ [label]: value }`. `value` above is always
+     * one of these VALUES or `null`. Empty when the enum type could not be found in the project.
+     */
+    options?: Record<string, string>;
+};
+/** A single-value design token (color). `cssVar` resolves the live, scheme-aware value. */
+export type DesignToken = {
+    id: string;
+    name: string;
+    /** Resolved base/default value (e.g. a hex string), or null when unset. */
+    resolved: string | null;
+    /** CSS custom-property reference, e.g. `var(--primaryColor)`. */
+    cssVar: string;
+};
+/** A typography token (text style). Apply `className` to an element to use it. */
+export type TypographyToken = {
+    id: string;
+    name: string;
+    /** Resolved CSS values keyed by camelCased CSS property (e.g. `fontSize`, `fontWeight`). */
+    resolved: Record<string, string>;
+    /** Class selector the editor emits for this text style, e.g. `_<id>`. */
+    className: string;
+    /** True when this is the theme's default/global text style (the editor's "Make Default Style"). */
+    isDefault: boolean;
+    /**
+     * Per-breakpoint values, widest first; present only when the style overrides at least one
+     * breakpoint. `className` already applies them through media queries — read this only when a
+     * value is needed in JS. Breakpoints without their own overrides are omitted: they use the next
+     * wider listed breakpoint, or the desktop `resolved` values.
+     */
+    breakpoints?: TypographyBreakpointToken[];
+};
+export type TypographyBreakpointToken = {
+    /** Theme breakpoint id (see `BreakpointToken`). */
+    id: string;
+    /** Media query max-width in px. */
+    width: number;
+    /** Only the values this breakpoint sets itself, keyed like `resolved`. */
+    overrides: Record<string, string>;
+    /** Full effective values at this breakpoint: desktop values plus inherited and own overrides. */
+    resolved: Record<string, string>;
+};
+export type BreakpointToken = {
+    id: string;
+    name: string;
+    width: number;
+};
+/** A resolved CSS style entry, e.g. { property: "animation-duration", value: "1.4s" }. */
+export type StyleEntry = {
+    property: string;
+    value: string;
+};
+export type KeyframeToken = {
+    id: string;
+    name: string;
+    type: string;
+    /** CSS reference — the animation name / class the editor emits, e.g. `_<id>`. */
+    ref: string;
+    /**
+     * Keyframe-level animation "settings" (the editor's Settings popover). These are CSS
+     * animation/transition properties and DIFFER BY TYPE: a `keyframe` carries
+     * animation-duration/-iteration-count/-play-state/-delay/-timing-function/-direction/
+     * -fill-mode/-timeline/-range + transform-origin; a `transition` carries `transition`.
+     * Both may carry backface-visibility. Empty when none are set.
+     */
+    settings?: StyleEntry[];
+    /** Animation points; each point may carry its own resolved styles. */
+    points?: {
+        point: string;
+        styles?: StyleEntry[];
+    }[];
+};
+/**
+ * A color SLOT — one entry of the top-level `getThemeColorSchemes().schemes` list. It is a
+ * label only (`id` + display `name`); the actual colors for the slot live in each palette's
+ * `colorsByScheme[id]`.
+ */
+export type ColorSchemeSlot = {
+    id: string;
+    name: string;
+};
+/**
+ * A color palette (one entry of `getThemeColorSchemes().values`). Its colors live in
+ * `colorsByScheme` — the top-level `schemes` list holds only slot id→name labels.
+ */
+export type ColorSchemeToken = {
+    id: string;
+    name: string;
+    isDefault: boolean;
+    /** Class selector to activate this scheme value, e.g. `_<id>`. */
+    className: string;
+    /**
+     * This palette's colors, keyed by color-SLOT id (the ids in
+     * `getThemeColorSchemes().schemes`). THIS — not the top-level `schemes` array — is
+     * the source of truth for swatch colors; iterate it to render a palette. Prefer
+     * `cssVar` for live, in-editor reactivity; `resolved` is a render-time snapshot.
+     */
+    colorsByScheme: Record<string, {
+        resolved: string | null;
+        cssVar: string;
+    }>;
+};
+export type ThemeGlobals = {
+    settings: Record<string, ThemeSetting>;
+    colors: DesignToken[];
+    typography: TypographyToken[];
+    breakpoints: BreakpointToken[];
+    keyframes: KeyframeToken[];
+    colorSchemes: {
+        schemes: ColorSchemeSlot[];
+        values: ColorSchemeToken[];
+    };
+};
+/**
+ * Stamps a theme-token type as its RUNTIME view (what the `@ikas/bp-storefront` getters return).
+ * `name` is authoring-only: it is non-unique (two design assets can ship the same one) and
+ * non-stable (renaming must not break references), so matching a token by name is unsafe.
+ * Identify one by its STABLE `id` instead — color → `cssVar` (`var(--<id>)`), typography &
+ * keyframe → `className` / `ref` (`_<id>`), color-scheme slot → a `colorsByScheme` key. Need a
+ * human-readable label? Read `list_theme_globals` (MCP/CLI) or the editor's Styles panel.
+ *
+ * `name` is REMOVED outright rather than re-added as a documented `@deprecated never`: that was
+ * tried first and only yields a soft strikethrough, so `getThemeTypography().find(t => t.name ===
+ * "…")` still compiled and agents wrote it anyway. A hard `Omit` makes it a compile error, and
+ * `ikas-component build` runs `tsc --noEmit` and exits non-zero on it — so such a component cannot
+ * be built or shipped at all.
+ *
+ * The full {@link ThemeGlobals} (with real names) is still what the config holds and what the
+ * CLI/MCP `list-theme-globals` AUTHORING read returns — that is how an agent resolves "the token
+ * named X" to its id. `name` is hidden only at these runtime getter return types.
+ */
+type RuntimeView<T> = Omit<T, "name">;
+export type RuntimeDesignToken = RuntimeView<DesignToken>;
+export type RuntimeTypographyToken = RuntimeView<TypographyToken>;
+export type RuntimeBreakpointToken = RuntimeView<BreakpointToken>;
+export type RuntimeKeyframeToken = RuntimeView<KeyframeToken>;
+export type RuntimeColorSchemeToken = RuntimeView<ColorSchemeToken>;
+export type RuntimeColorSchemeSlot = RuntimeView<ColorSchemeSlot>;
+/**
+ * Runtime view of {@link ThemeGlobals.colorSchemes} (returned by `getThemeColorSchemes`). The
+ * slot list carries only `{ id }`: slot display LABELS (the slot `name`) are authoring-only —
+ * read them via the CLI/MCP `list-theme-globals` or the editor, not at runtime. Render a palette
+ * by iterating each value's `colorsByScheme`, keyed by slot id.
+ */
+export type RuntimeThemeColorSchemes = {
+    schemes: RuntimeColorSchemeSlot[];
+    values: RuntimeColorSchemeToken[];
+};
+export declare const EMPTY_THEME_GLOBALS: ThemeGlobals;
+type StyleValueLike = {
+    value?: any;
+    patternValueId?: string;
+    keyframeValueId?: string;
+    colorSchemeId?: string;
+};
+type StyleConditionLike = {
+    value?: StyleValueLike;
+};
+type ElementStyleLike = {
+    property: string;
+    value?: StyleValueLike | StyleConditionLike[];
+};
+type PatternValueLike = {
+    id: string;
+    name?: string;
+    style?: ElementStyleLike;
+};
+type PatternElementLike = {
+    id: string;
+    name?: string;
+    styles?: ElementStyleLike[];
+    isDefault?: boolean;
+    breakpointStyles?: {
+        breakpointId: string;
+        styles?: ElementStyleLike[];
+    }[];
+};
+type ColorSchemeLike = {
+    id: string;
+    name?: string;
+};
+type ColorSchemeValueColorLike = {
+    colorSchemeId: string;
+    style?: StyleValueLike;
+};
+type ColorSchemeValueLike = {
+    id: string;
+    name?: string;
+    isDefault?: boolean;
+    /** Set when this scheme belongs to an installed design asset; groups the default fallback. */
+    designAssetId?: string;
+    colors?: ColorSchemeValueColorLike[];
+};
+type BreakpointLike = {
+    id: string;
+    name?: string;
+    width?: number | string;
+};
+type KeyframePointLike = {
+    point: string;
+    styles?: ElementStyleLike[];
+};
+type KeyframeLike = {
+    id: string;
+    name?: string;
+    type?: string;
+    styles?: ElementStyleLike[];
+    points?: KeyframePointLike[];
+};
+type VariableLike = {
+    id?: string;
+    variableName?: string;
+    displayName?: string;
+    variableType?: string;
+    /** Blueprint type id. For an ENUM global this is the enum type's id (`project.types[].id`). */
+    typeId?: string;
+    defaultValue?: any;
+    isGlobal?: boolean;
+};
+/** The slice of a project `IType` an ENUM setting reads: its id and its `{ label: value }` options. */
+type TypeLike = {
+    id: string;
+    type?: unknown;
+    enumOptions?: Record<string, any> | null;
+};
+export type SerializableProject = {
+    globalsBlueprint?: {
+        module?: {
+            variables?: VariableLike[];
+        };
+    };
+    /** Project custom types; only enum entries are read, to resolve ENUM settings' options. */
+    types?: TypeLike[];
+    theme?: {
+        breakpoints?: BreakpointLike[];
+        keyframes?: KeyframeLike[];
+        pattern?: {
+            values?: PatternValueLike[];
+            elements?: PatternElementLike[];
+            colorSchemes?: ColorSchemeLike[];
+            colorSchemeValues?: ColorSchemeValueLike[];
+        };
+    };
+};
+export declare const cssVarRef: (id: string, fallback?: string) => string;
+export declare const rawClassRef: (id: string) => string;
+/**
+ * CSS function-style token a code component writes to reference a theme breakpoint's width.
+ * Breakpoints can't ship as `var(--…)` because the CSS spec forbids `var()` in a media-query
+ * condition — and a `var()` there fails SILENTLY (it parses as valid-looking CSS but the whole
+ * query is dropped). So a code component writes a deliberately non-standard `bp(<breakpointId>)`
+ * token inside its OWN `min-width` / `max-width` condition; it resolves to a concrete `<width>px`
+ * at render time against the LIVE theme (see {@link resolveBreakpointMediaTokens}). The author
+ * picks the direction, so there is no implicit boundary magic:
+ *   `@media (max-width: bp(_mob))` -> `@media (max-width: 767px)`
+ *   `@media (min-width: bp(_mob))` -> `@media (min-width: 767px)`
+ * id-based, never a human name (the id is stable across renames). The id comes from
+ * `list-theme-globals` / `getThemeBreakpoints()`.
+ */
+export declare const breakpointCssToken: (id: string) => string;
+/**
+ * Coerce a theme's breakpoint list into the `{ id, width }` shape {@link resolveBreakpointMediaTokens}
+ * needs, defaulting a missing/non-numeric width to 0. Shared by both render sites so the coercion
+ * rule lives in one place; the editor passes `breakpoints.map(b => b.toJSON())` (Yjs → plain) first.
+ */
+export declare const toResolverBreakpoints: (breakpoints: {
+    id: string;
+    width?: number | string;
+}[]) => {
+    id: string;
+    width: number;
+}[];
+/**
+ * Replace breakpoint width tokens (`bp(<id>)`) in a CSS string with the breakpoint's concrete
+ * `<width>px`, using the given theme breakpoints. Pure text substitution — the single place
+ * breakpoint resolution lives, called at every render-time CC-CSS composition site
+ * (code-generator, editor canvas). Unknown ids are left untouched (the partner dependency
+ * collector ships referenced breakpoints into the target theme, so a real token always resolves).
+ * The `bp(<id>)` literal carries its own `)` boundary, so one id is never matched inside another.
+ *
+ * A `calc()` containing a bp token (e.g. the documented exclusive boundary
+ * `calc(bp(<id>) + 1px)`, but any pure px arithmetic: `calc(bp(a) * 2 + 10px)`,
+ * `calc(bp(a) - bp(b))`, `-webkit-calc(...)`, …) is folded to a single computed `<width>px`
+ * literal, never emitted as `calc()`: csso — the code-generator's minifier for inline/base
+ * page styles — silently drops a media block whose condition contains `calc()`, and older
+ * browsers (e.g. Safari < 16.4) don't evaluate `calc()` in media conditions either.
+ *
+ * Folding limits (an out-of-limit calc degrades to plain token substitution, keeping its
+ * `calc()` form — which csso will still drop from a media condition): bodies longer than
+ * CALC_SCAN_LIMIT chars; an uppercase `CALC(` keyword (the scan is lowercase, matching every
+ * compiled-CSS emitter); `calc(` inside a string/comment can confuse the plain-text scan.
+ */
+export declare function resolveBreakpointMediaTokens(css: string, breakpoints: {
+    id: string;
+    width: number;
+}[]): string;
+/**
+ * True for system/reserved global variables (e.g. `__breakpointsVar__`) — internal
+ * constructs that live in `module.variables` but are NOT user-facing theme settings.
+ * Single source of truth for the `__name__` reserved-id convention; consumers (theme
+ * serialization here, partner publish dependency collection) share it so a new
+ * synthetic var is excluded everywhere at once.
+ */
+export declare const isReservedVariableId: (id?: string | null) => boolean;
+/**
+ * Build the {@link ThemeGlobals} payload from a project's theme. Pure and dependency-free
+ * (works on plain JSON), so the same function serves SSR (`IProject`) and the editor canvas
+ * (`YjsProject.toJSON()`).
+ */
+export declare function serializeThemeGlobals(project?: SerializableProject | null): ThemeGlobals;
+export {};

package/dist/storefront-models/src/index.d.ts

@@ -108,6 +108,7 @@ export * from "./models/order/address/state";
 export * from "./models/order/adjustment";
 export * from "./models/order/adjustment/applied-order-line";
 export * from "./models/order/customer";
+export * from "./models/order/gift-card-line";
 export * from "./models/order/gift-line";
 export * from "./models/order/invoice";
 export * from "./models/order/line-item";
@@ -132,6 +133,11 @@ export * from "./models/order/payment-method";
 export * from "./models/order/refund";
 export * from "./models/order/refund/line-item";
 export * from "./models/order/refund/settings";
+export * from "./models/order/refund/settings/translation";
+export * from "./models/order/refund/reason";
+export * from "./models/order/refund/reason/translation";
+export * from "./models/order/refund/refundable-line";
+export * from "./models/order/refund/refundable-lines";
 export * from "./models/order/shipping-line";
 export * from "./models/order/tax-line";
 export * from "./models/order/transaction";
@@ -157,6 +163,7 @@ export * from "./models/product/campaign/filter";
 export * from "./models/product/campaign/product-buyx-then-gety";
 export * from "./models/product/campaign/product-campaign-date-range-field";
 export * from "./models/product/campaign/product-fixed-discount";
+export * from "./models/product/campaign/product-tiered-discount";
 export * from "./models/product/campaign-offer";
 export * from "./models/product/filter";
 export * from "./models/product/group";
@@ -227,6 +234,7 @@ export * from "./models/validator/back-in-stock-notification";
 export * from "./models/validator/contact-form";
 export * from "./models/validator/coupon-code-form";
 export * from "./models/validator/customer-review";
+export * from "./models/validator/deactivate-customer";
 export * from "./models/validator/forgot-password";
 export * from "./models/validator/login";
 export * from "./models/validator/newsletter-subscription";

package/dist/storefront-models/src/models/blueprint/prop-value/attribute-list.d.ts

@@ -1,6 +1,8 @@
+import { IBlueprintPropValueVariableBinding } from "./variable-binding";
 export interface IBlueprintAttributeListPropValue {
     productId?: string | null;
     variantId?: string | null;
     attributeIds?: string[] | null;
     usePageData?: boolean | null;
+    productVariable?: IBlueprintPropValueVariableBinding | null;
 }

package/dist/storefront-models/src/models/blueprint/prop-value/attribute.d.ts

@@ -1,6 +1,8 @@
+import { IBlueprintPropValueVariableBinding } from "./variable-binding";
 export interface IBlueprintAttributePropValue {
     productId?: string | null;
     variantId?: string | null;
     attributeId?: string | null;
     usePageData?: boolean | null;
+    productVariable?: IBlueprintPropValueVariableBinding | null;
 }

package/dist/storefront-models/src/models/blueprint/prop-value/color.d.ts

@@ -1,3 +1,5 @@
 export interface IBlueprintColorPropValue {
     value: string;
+    patternValueId?: string;
+    colorSchemeId?: string;
 }

package/dist/storefront-models/src/models/blueprint/prop-value/index.d.ts

@@ -28,4 +28,5 @@ export * from "./rich-text";
 export * from "./svg";
 export * from "./svg-list";
 export * from "./text";
+export * from "./variable-binding";
 export * from "./video";

package/dist/storefront-models/src/models/blueprint/prop-value/link.d.ts

@@ -1,9 +1,19 @@
 import { IkasNavigationLinkType } from "../../navigation-link";
 import { IkasThemePageType } from "../../theme";
+export interface IBlueprintLinkLabelTranslation {
+    locale: string;
+    label: string;
+    /** The routing the label is for; none: every routing speaking `locale` without one of its own. */
+    sfRoutingId?: string | null;
+}
 export interface IBlueprintLinkPropValue {
     id?: string | null;
     linkType?: IkasNavigationLinkType | null;
     label?: string | null;
+    /** The label is the linked product's, category's or brand's name, shown in the routing's language. */
+    useItemNameTranslations?: boolean | null;
+    /** The label on other routings and languages; the list's links, their order and targets are the same everywhere. */
+    translations?: IBlueprintLinkLabelTranslation[] | null;
     pageId?: string | null;
     pageType?: IkasThemePageType | null;
     itemId?: string | null;

package/dist/storefront-models/src/models/blueprint/prop-value/variable-binding.d.ts

@@ -0,0 +1,16 @@
+/**
+ * A theme data binding stored INSIDE a prop value, so a single field of that value can follow a
+ * bound variable while the rest of the value stays statically authored (see
+ * `IBlueprintAttributePropValue.productVariable`). `key`/`variableId`/`path` mirror the editor's
+ * `IThemeVariableBinding` and `refId`/`componentId` mirror the surrounding `IThemeDynamicValueValue`
+ * context a COMPONENT_LIST child needs to resolve an ancestor's variable; duplicated here because
+ * storefront-models must not depend on editor-models. Only the editor and the code generators
+ * interpret it — the storefront runtime carries it through untouched.
+ */
+export interface IBlueprintPropValueVariableBinding {
+    key?: string | null;
+    variableId?: string | null;
+    path?: string[] | null;
+    refId?: string | null;
+    componentId?: string | null;
+}

package/dist/storefront-models/src/models/image/index.d.ts

@@ -1,5 +1,12 @@
 export type IkasImage = {
     id: string;
+    /**
+     * True when this media item is a VIDEO, not an image. Product media sets routinely mix both.
+     * getDefaultSrc/getSrc/getThumbnailSrc then return an .mp4 URL, so rendering it in an <img>
+     * produces broken media — branch on this flag and render <video src={getDefaultSrc(item)}>.
+     * Videos have no resized variant and no poster URL: the size argument is ignored, and
+     * createMediaSrcset does not apply.
+     */
     isVideo?: boolean | null;
     altText?: string | null;
     fileName?: string | null;

package/dist/storefront-models/src/models/loyalty-program/customer-info/index.d.ts

@@ -9,7 +9,9 @@ export type IkasCartLoyaltyLine = {
     pointUsed: number;
 };
 export type IkasLoyaltyCustomerInfo = {
+    availablePoint: number;
     cartLoyaltyLines: IkasCartLoyaltyLine[] | null;
+    cumulativeEarnedPoints: number;
     customerTier: IkasLoyaltyProgramTier | null;
     loyaltyProgramCustomerId: string;
     loyaltyProgramId: string;

package/dist/storefront-models/src/models/loyalty-program/earning-method/index.d.ts

@@ -20,6 +20,7 @@ export type IkasLoyaltyProgramEarningMethod = {
     translations: LoyaltyProgramMethodTranslation[] | null;
     updatedAt: any | null;
     validityPeriod: LoyaltyProgramPeriod | null;
+    waitingPeriodDays: number | null;
 };
 export type IkasLoyaltyProgramEarningMethodOrderSettings = {
     maxOrderAmount: number | null;

package/dist/storefront-models/src/models/loyalty-program/index.d.ts

@@ -17,6 +17,7 @@ export type IkasLoyaltyProgram = {
     tokenName: string | null;
     updatedAt: any | null;
     validityPeriod: LoyaltyProgramPeriod | null;
+    waitingPeriodDays: number | null;
 };
 export * from "./customer-info";
 export * from "./earning-method";

package/dist/storefront-models/src/models/loyalty-program/point-history/index.d.ts

@@ -1,6 +1,7 @@
 import { LoyaltyProgramPointHistoryTypeEnum } from "../../../../../storefront-api/src";
 export type IkasLoyaltyProgramPointHistory = {
     amount: number;
+    availableDate: any | null;
     createdAt: any | null;
     customerId: string;
     deleted: boolean;

package/dist/storefront-models/src/models/order/gift-card-line/index.d.ts

@@ -0,0 +1,15 @@
+import { IkasTransactionType } from "../transaction";
+export type IkasOrderGiftCardLine = {
+    id: string;
+    amount: number;
+    code: string;
+    giftCardId: string;
+    type: IkasGiftCardType | null;
+    appliedTransactions: IkasOrderGiftCardLineAppliedTransaction[];
+};
+export type IkasOrderGiftCardLineAppliedTransaction = {
+    id: string;
+    amount: number;
+    type: IkasTransactionType;
+};
+export type IkasGiftCardType = "GIFT_CARD" | "STORE_CREDIT";

package/dist/storefront-models/src/models/order/index.d.ts

@@ -1,11 +1,15 @@
 import { IkasOrderAddress } from "./address";
 import { IkasOrderAdjustment } from "./adjustment";
 import { IkasOrderCustomer } from "./customer";
+import { IkasOrderGiftCardLine } from "./gift-card-line";
 import { IkasOrderGiftPackageLine } from "./gift-line";
 import { IkasInvoice } from "./invoice";
 import { IkasOrderLineItem } from "./line-item";
 import { IkasOrderPackage } from "./package";
 import { IkasOrderPaymentMethod } from "./payment-method";
+import { IkasOrderRefundReason } from "./refund/reason";
+import { IkasRefundableLine } from "./refund/refundable-line";
+import { IkasOrderRefundSettingsTranslation } from "./refund/settings/translation";
 import { IkasOrderShippingLine } from "./shipping-line";
 import { IkasOrderTaxLine } from "./tax-line";
 import { IkasOrderTransaction } from "./transaction";
@@ -21,6 +25,7 @@ export type IkasOrder = {
     currencySymbol: string | null;
     customer: IkasOrderCustomer | null;
     customerId: string | null;
+    giftCardLines: IkasOrderGiftCardLine[] | null;
     giftPackageLines: IkasOrderGiftPackageLine[] | null;
     giftPackageNote: string | null;
     invoices: IkasInvoice[] | null;
@@ -43,6 +48,11 @@ export type IkasOrder = {
     totalFinalPrice: number;
     totalPrice: number;
     transactions?: IkasOrderTransaction[];
+    _refundableLines?: IkasRefundableLine[] | null;
+    _refundReasons?: IkasOrderRefundReason[] | null;
+    _refundTranslations?: IkasOrderRefundSettingsTranslation[] | null;
+    _refundReasonId?: string | null;
+    _refundReason?: string | null;
 };
 export type IkasOrderCancelReason = "CUSTOMER" | "DECLINED" | "INVENTORY" | "OTHER";
 export type IkasOrderPackageStatus = "CANCELLED" | "CANCEL_REJECTED" | "CANCEL_REQUESTED" | "DELIVERED" | "FULFILLED" | "PARTIALLY_CANCELLED" | "PARTIALLY_DELIVERED" | "PARTIALLY_FULFILLED" | "PARTIALLY_READY_FOR_SHIPMENT" | "PARTIALLY_REFUNDED" | "READY_FOR_PICK_UP" | "READY_FOR_SHIPMENT" | "REFUNDED" | "REFUND_REJECTED" | "REFUND_REQUESTED" | "REFUND_REQUEST_ACCEPTED" | "RETURN_DELIVERED" | "RETURN_IN_TRANSIT" | "RETURN_PARCEL_WAITING" | "RETURN_REJECTED" | "UNABLE_TO_DELIVER" | "UNFULFILLED";

package/dist/storefront-models/src/models/order/line-item/index.d.ts

@@ -1,3 +1,4 @@
+import { IkasOrderRefundFlow } from "../refund/refundable-line";
 import { IkasOrderLineBundleProductSettings } from "./bundle-product-settings";
 import { IkasOrderLineDiscount } from "./discount";
 import { IkasOrderLineItemOption } from "./option";
@@ -25,6 +26,10 @@ export type IkasOrderLineItem = {
     variant: IkasOrderLineVariant;
     bundleProductSettings: IkasOrderLineBundleProductSettings | null;
     orderedAt: number;
+    flow?: IkasOrderRefundFlow | null;
+    autoApprove?: boolean;
+    isCancellable?: boolean;
+    isRefundable?: boolean;
     _refundQuantity: number | null;
 };
-export type IkasOrderLineItemStatus = "CANCELLED" | "CANCEL_REJECTED" | "CANCEL_REQUESTED" | "DELIVERED" | "FULFILLED" | "REFUNDED" | "REFUND_REJECTED" | "REFUND_REQUESTED" | "REFUND_REQUEST_ACCEPTED" | "UNFULFILLED";
+export type IkasOrderLineItemStatus = "CANCELLED" | "CANCEL_REJECTED" | "CANCEL_REQUESTED" | "DELIVERED" | "FULFILLED" | "PLANNED" | "REFUNDED" | "REFUND_REJECTED" | "REFUND_REQUESTED" | "REFUND_REQUEST_ACCEPTED" | "RETURN_DELIVERED" | "RETURN_IN_TRANSIT" | "RETURN_PARCEL_WAITING" | "RETURN_REJECTED" | "UNFULFILLED" | "WAITING_FOR_PACKAGING";

package/dist/storefront-models/src/models/order/package/index.d.ts

@@ -13,7 +13,7 @@ export type IkasOrderPackage = {
     stockLocationId: string;
     trackingInfo: IkasTrackingInfo | null;
 };
-export type IkasOrderPackageFullfillStatus = "UNFULFILLED" | "CANCELLED" | "CANCEL_REJECTED" | "CANCEL_REQUESTED" | "DELIVERED" | "ERROR" | "FULFILLED" | "READY_FOR_PICK_UP" | "READY_FOR_SHIPMENT" | "REFUNDED" | "REFUND_REJECTED" | "REFUND_REQUESTED" | "REFUND_REQUEST_ACCEPTED" | "UNABLE_TO_DELIVER";
+export type IkasOrderPackageFullfillStatus = "CANCELLED" | "CANCEL_REJECTED" | "CANCEL_REQUESTED" | "DELIVERED" | "ERROR" | "FULFILLED" | "PLANNED" | "READY_FOR_PICK_UP" | "READY_FOR_SHIPMENT" | "REFUNDED" | "REFUND_REJECTED" | "REFUND_REQUESTED" | "REFUND_REQUEST_ACCEPTED" | "RETURN_DELIVERED" | "RETURN_IN_TRANSIT" | "RETURN_PARCEL_WAITING" | "RETURN_REJECTED" | "UNABLE_TO_DELIVER" | "UNFULFILLED" | "WAITING_FOR_PACKAGING";
 export type IkasDisplayedPackage = {
     id: string;
     createdAt: number;

package/dist/storefront-models/src/models/order/refund/reason/index.d.ts

@@ -0,0 +1,6 @@
+import { IkasOrderRefundReasonTranslation } from "./translation";
+export type IkasOrderRefundReason = {
+    id: string;
+    title: string;
+    translations: IkasOrderRefundReasonTranslation[] | null;
+};

package/dist/storefront-models/src/models/order/refund/reason/translation/index.d.ts

@@ -0,0 +1,4 @@
+export type IkasOrderRefundReasonTranslation = {
+    locale: string;
+    title: string | null;
+};

package/dist/storefront-models/src/models/order/refund/refundable-line/index.d.ts

@@ -0,0 +1,8 @@
+export type IkasOrderRefundFlow = "CANCEL" | "RETURN";
+export type IkasRefundableLine = {
+    autoApprove: boolean;
+    flow: IkasOrderRefundFlow | null;
+    isCancellable: boolean;
+    isRefundable: boolean;
+    orderLineItemId: string;
+};

package/dist/storefront-models/src/models/order/refund/refundable-lines/index.d.ts

@@ -0,0 +1,8 @@
+import { IkasOrderRefundReason } from "../reason";
+import { IkasRefundableLine } from "../refundable-line";
+import { IkasOrderRefundSettingsTranslation } from "../settings/translation";
+export type IkasRefundableLines = {
+    orderLineItems: IkasRefundableLine[];
+    refundReasons: IkasOrderRefundReason[];
+    translations: IkasOrderRefundSettingsTranslation[];
+};

package/dist/storefront-models/src/models/order/refund/settings/translation/index.d.ts

@@ -0,0 +1,4 @@
+export type IkasOrderRefundSettingsTranslation = {
+    locale: string;
+    returnMethodDescription: string | null;
+};

package/dist/storefront-models/src/models/payment-gateway/index.d.ts

@@ -12,6 +12,8 @@ export type IkasPaymentGateway = {
     description: string | null;
     logoUrl: string | null;
     masterPassClientId: string | null;
+    /** True when Miles&Smiles can be redeemed on this (TK_PAY) gateway. */
+    milesSmilesEnabled?: boolean | null;
     name: string;
     paymentGatewayProviderId: string | null;
     supportedCurrencies: string[] | null;
@@ -22,7 +24,7 @@ export type IkasPaymentGateway = {
     settings?: IkasPaymentGatewaySettings[] | null;
     translations?: IkasPaymentGatewayTranslation[] | null;
 };
-export type IkasPaymentMethodType = "APP_PAYMENT" | "BANK_REDIRECT" | "BUY_ONLINE_PAY_AT_STORE" | "CASH" | "CASH_ON_DELIVERY" | "CREDIT_CARD" | "CREDIT_CARD_ON_DELIVERY" | "DIRECT_DEBIT" | "GIFT_CARD" | "MONEY_ORDER" | "OTHER" | "PAY_LATER" | "SLICE_IT" | "WALLET";
+export type IkasPaymentMethodType = "APP_PAYMENT" | "BANK_REDIRECT" | "BUY_ONLINE_PAY_AT_STORE" | "CASH" | "CASH_ON_DELIVERY" | "CREDIT_CARD" | "CREDIT_CARD_ON_DELIVERY" | "DIRECT_DEBIT" | "GIFT_CARD" | "MONEY_ORDER" | "OTHER" | "PAY_LATER" | "SLICE_IT" | "STORE_CREDIT" | "WALLET";
 export type IkasPaymentMethod = {
     name: string;
     logoUrl: string | null;