@fas-core/shared-types 1.0.88 → 1.0.90

package/dist/index.d.mts

@@ -218,6 +218,7 @@ interface IBrand extends BaseEntity {
     stores: IStore[];
     sortOrder: number;
     status: boolean;
+    isOnline: boolean;
     metaData: Metadata;
     seoMetaData: ISEOMetaData;
 }
@@ -233,6 +234,7 @@ interface ICategory extends BaseEntity {
     banners: IBannerSlide[];
     sortOrder: number;
     status: boolean;
+    isOnline: boolean;
     metaData: Metadata;
     seoMetaData: ISEOMetaData;
     subCategories?: ICategory[];
@@ -276,6 +278,7 @@ interface IProductVariantFields {
     metaData: Metadata;
     seoMetaData: ISEOMetaData;
     status: boolean;
+    isOnline: boolean;
 }
 
 type VariantOptionMode = "OPTION_BACKED" | "MANUAL";
@@ -412,6 +415,12 @@ interface IOrderItem extends BaseEntity {
     variant?: IVariant;
     pricing: ILinePricing;
     metaData: Metadata;
+    bundleId?: string | null;
+    bundleTitle?: string | null;
+    bundleConfiguratorKey?: string | null;
+    bundleQuantity?: number;
+    bundleUnitQuantity?: number | null;
+    note?: string;
 }
 
 declare const PaymentStatusEnum: {
@@ -713,6 +722,168 @@ interface IEmailTemplate extends BaseEntity {
     status: boolean;
 }
 
+declare const ConfiguratorSelectModeEnum: {
+    readonly SINGLE: "SINGLE";
+    readonly MULTI: "MULTI";
+};
+type ConfiguratorSelectModeEnum = (typeof ConfiguratorSelectModeEnum)[keyof typeof ConfiguratorSelectModeEnum];
+declare const CONFIGURATOR_SELECT_MODE_VALUES: ("SINGLE" | "MULTI")[];
+declare const ConfiguratorSourceEnum: {
+    readonly PICKED: "PICKED";
+    readonly QUERY: "QUERY";
+};
+type ConfiguratorSourceEnum = (typeof ConfiguratorSourceEnum)[keyof typeof ConfiguratorSourceEnum];
+declare const CONFIGURATOR_SOURCE_VALUES: ("PICKED" | "QUERY")[];
+declare const ConfiguratorConditionTypeEnum: {
+    readonly SELECTED: "SELECTED";
+    readonly ALL: "ALL";
+    readonly ANY: "ANY";
+    readonly NOT: "NOT";
+};
+type ConfiguratorConditionTypeEnum = (typeof ConfiguratorConditionTypeEnum)[keyof typeof ConfiguratorConditionTypeEnum];
+declare const CONFIGURATOR_CONDITION_TYPE_VALUES: ("SELECTED" | "ALL" | "ANY" | "NOT")[];
+declare const ConfiguratorEffectTypeEnum: {
+    readonly SHOW: "SHOW";
+    readonly HIDE: "HIDE";
+    readonly REQUIRE: "REQUIRE";
+    readonly OPTIONAL: "OPTIONAL";
+    readonly SELECT: "SELECT";
+    readonly DESELECT: "DESELECT";
+    readonly PRICE_ADJUST: "PRICE_ADJUST";
+};
+type ConfiguratorEffectTypeEnum = (typeof ConfiguratorEffectTypeEnum)[keyof typeof ConfiguratorEffectTypeEnum];
+declare const CONFIGURATOR_EFFECT_TYPE_VALUES: ("SHOW" | "HIDE" | "REQUIRE" | "OPTIONAL" | "SELECT" | "DESELECT" | "PRICE_ADJUST")[];
+declare const ConfiguratorErrorCodeEnum: {
+    readonly REQUIRED_SECTION_EMPTY: "REQUIRED_SECTION_EMPTY";
+    readonly OPTION_NOT_AVAILABLE: "OPTION_NOT_AVAILABLE";
+    readonly SECTION_NOT_AVAILABLE: "SECTION_NOT_AVAILABLE";
+    readonly UNKNOWN_SECTION: "UNKNOWN_SECTION";
+    readonly SINGLE_SELECT_OVERFILLED: "SINGLE_SELECT_OVERFILLED";
+    readonly RULES_UNSTABLE: "RULES_UNSTABLE";
+};
+type ConfiguratorErrorCodeEnum = (typeof ConfiguratorErrorCodeEnum)[keyof typeof ConfiguratorErrorCodeEnum];
+declare const CONFIGURATOR_ERROR_CODE_VALUES: ("REQUIRED_SECTION_EMPTY" | "OPTION_NOT_AVAILABLE" | "SECTION_NOT_AVAILABLE" | "UNKNOWN_SECTION" | "SINGLE_SELECT_OVERFILLED" | "RULES_UNSTABLE")[];
+interface IConfiguratorQuery {
+    search?: string;
+    categories?: string[];
+    brands?: string[];
+    types?: string[];
+    minPrice?: number;
+    maxPrice?: number;
+    inStock?: boolean;
+    limit?: number;
+}
+interface IConfiguratorFacetValue {
+    key: string;
+    label: string;
+    tags?: string[];
+    query?: IConfiguratorQuery;
+    isDefault?: boolean;
+}
+interface IConfiguratorFacet {
+    key: string;
+    label: string;
+    values: IConfiguratorFacetValue[];
+}
+interface IConfiguratorOption {
+    key: string;
+    sku: string;
+    tags?: string[];
+    sortOrder?: number;
+}
+interface IConfiguratorSection {
+    key: string;
+    title: string;
+    description?: string;
+    selectMode: ConfiguratorSelectModeEnum;
+    required: boolean;
+    source: ConfiguratorSourceEnum;
+    options?: IConfiguratorOption[];
+    query?: IConfiguratorQuery;
+    facets?: IConfiguratorFacet[];
+    contentHtml?: string;
+    sortOrder?: number;
+}
+interface IConfiguratorStep {
+    key: string;
+    title: string;
+    description?: string;
+    sections: IConfiguratorSection[];
+    sortOrder?: number;
+}
+interface IConfiguratorTarget {
+    sectionKey: string;
+    optionKey?: string;
+    tag?: string;
+}
+type IConfiguratorCondition = {
+    type: typeof ConfiguratorConditionTypeEnum.SELECTED;
+    sectionKey: string;
+    optionKeys?: string[];
+} | {
+    type: typeof ConfiguratorConditionTypeEnum.ALL | typeof ConfiguratorConditionTypeEnum.ANY;
+    conditions: IConfiguratorCondition[];
+} | {
+    type: typeof ConfiguratorConditionTypeEnum.NOT;
+    condition: IConfiguratorCondition;
+};
+interface IConfiguratorEffect {
+    type: ConfiguratorEffectTypeEnum;
+    target: IConfiguratorTarget;
+    mode?: PricingType;
+    amount?: number;
+}
+interface IConfiguratorPriceAdjustment {
+    sectionKey: string;
+    optionKey?: string;
+    mode: PricingType;
+    amount: number;
+}
+interface IConfiguratorRule {
+    key: string;
+    description?: string;
+    when: IConfiguratorCondition;
+    then: IConfiguratorEffect[];
+}
+interface IConfigurator extends BaseEntity {
+    name: string;
+    key: string;
+    description: string;
+    images?: string[];
+    stores: (IStore | string)[];
+    steps: IConfiguratorStep[];
+    rules: IConfiguratorRule[];
+    sortOrder: number;
+    isVisible: boolean;
+    status: boolean;
+}
+type ConfiguratorSelections = Record<string, string[]>;
+
+interface ConfiguratorEvalContext {
+    optionKeysBySection?: Record<string, string[]>;
+}
+interface ConfiguratorEvalError {
+    code: ConfiguratorErrorCodeEnum;
+    sectionKey: string;
+    optionKey?: string;
+}
+interface ConfiguratorEvalResult {
+    selections: ConfiguratorSelections;
+    hiddenSections: string[];
+    hiddenOptions: string[];
+    requiredSections: string[];
+    errors: ConfiguratorEvalError[];
+    priceAdjustments: IConfiguratorPriceAdjustment[];
+    stable: boolean;
+    hiddenBy: Record<string, string>;
+    selectedBy: Record<string, string>;
+}
+declare const conditionHolds: (condition: IConfiguratorCondition | undefined, selections: ConfiguratorSelections) => boolean;
+declare const evaluateConfigurator: (config: IConfigurator, selections: ConfiguratorSelections, context?: ConfiguratorEvalContext) => ConfiguratorEvalResult;
+declare const applyPriceAdjustments: (baseUnitPrice: number, adjustments: IConfiguratorPriceAdjustment[]) => number;
+declare const adjustmentsFor: (adjustments: IConfiguratorPriceAdjustment[], sectionKey: string, optionKey: string) => IConfiguratorPriceAdjustment[];
+declare const isConfigurationValid: (result: ConfiguratorEvalResult) => boolean;
+
 type RedirectTargetType = "product" | "variant" | "category" | "url";
 interface IRedirectSuggestion {
     targetType: RedirectTargetType;
@@ -745,6 +916,8 @@ interface IUnmatched404 extends BaseEntity {
 }
 
 declare const normalizePath: (input: string) => string;
+declare const canonicalizeSlug: (input: string) => string;
+declare const canonicalizePath: (input: string) => string;
 
 declare const roundMoney: (amount: number) => number;
 declare const formatMoney: (value: number, currencyCode?: string) => string;
@@ -808,7 +981,75 @@ interface ICartItem extends BaseEntity {
     variant?: IVariant;
     pricing: ILinePricing;
     metaData: Metadata;
+    /**
+     * Groups the lines produced by one configurator build so the cart renders and removes
+     * them as a unit. Part of the line dedupe key — two bundles holding the same product
+     * must stay separate lines rather than merging into one.
+     */
+    bundleId?: string | null;
+    bundleTitle?: string | null;
+    /**
+     * Which configurator produced this bundle. Required once more than one can be published:
+     * the server validates a bundle against THIS configurator's rules, and the cart's reconfigure
+     * link reopens THIS one. Validating against "whichever is active" would check a build against
+     * the wrong rulebook.
+     */
+    bundleConfiguratorKey?: string | null;
+    /**
+     * How many copies of the whole configuration the customer ordered. `quantity` stays the
+     * EFFECTIVE figure so pricing, stock and orders need no change; `bundleUnitQuantity` keeps
+     * the per-bundle figure so the stepper can re-multiply without walking the wizard again.
+     */
+    bundleQuantity?: number;
+    bundleUnitQuantity?: number | null;
+    /** Buyer-entered line note. Survives to the order and appears on the confirmation. */
+    note?: string;
+}
+
+declare const MAX_BUNDLE_QUANTITY = 99;
+declare const normalizeBundleQuantity: (value: unknown) => number;
+declare const bundleLineQuantity: (unitQuantity: number, bundleQuantity: number) => number;
+declare const bundleUnitFrom: (line: {
+    bundleUnitQuantity?: number | null;
+    quantity: number;
+    bundleQuantity?: number | null;
+}) => number;
+interface BundleLine {
+    bundleId?: string | null;
+    bundleTitle?: string | null;
+    bundleQuantity?: number;
+    bundleUnitQuantity?: number | null;
+    pricing?: {
+        totalAmount?: number;
+    };
+}
+interface BundleGroup {
+    bundleId: string;
+    title: string;
+    quantity: number;
+    lines: number;
+    total: number;
 }
+declare const bundleGroupsOf: (items: BundleLine[]) => BundleGroup[];
+declare const orderByBundle: <T extends BundleLine>(items: T[]) => T[];
+
+interface StockDemandLine {
+    key: string;
+    quantity: number;
+}
+declare const demandByKey: (lines: StockDemandLine[]) => Map<string, number>;
+type StockVerdict = {
+    type: "OK";
+} | {
+    type: "OUT_OF_STOCK";
+    available: 0;
+    requested: number;
+} | {
+    type: "INSUFFICIENT_STOCK";
+    available: number;
+    requested: number;
+};
+declare const stockVerdict: (available: number, requested: number) => StockVerdict;
 
 declare const CartStatusEnum: {
     readonly ACTIVE: "ACTIVE";
@@ -934,6 +1175,78 @@ interface ICampaignRecipient extends BaseEntity {
     lastEventAt?: Date | string;
 }
 
+interface IBlogAuthor extends BaseEntity {
+    name: string;
+    slug: string;
+    bio: string;
+    avatar: string;
+    role: string;
+    status: boolean;
+    isOnline: boolean;
+    metaData: Metadata;
+    seoMetaData: ISEOMetaData;
+}
+interface IBlogCategory extends BaseEntity {
+    name: string;
+    slug: string;
+    description: string;
+    image: string;
+    sortOrder: number;
+    status: boolean;
+    isOnline: boolean;
+    metaData: Metadata;
+    seoMetaData: ISEOMetaData;
+}
+interface IBlogCitation {
+    label: string;
+    url: string;
+    source?: string;
+}
+interface IBlogPost extends BaseEntity {
+    title: string;
+    slug: string;
+    excerpt: string;
+    content: string;
+    headerImage: string;
+    headerImageAlt: string;
+    thumbnail: string;
+    thumbnailAlt: string;
+    author: IBlogAuthor | string | null;
+    category: IBlogCategory | string | null;
+    tags: string[];
+    citations: IBlogCitation[];
+    relatedProducts: unknown[];
+    readingMinutes: number;
+    publishedAt: Date | string | null;
+    stores: IStore[];
+    status: boolean;
+    isOnline: boolean;
+    metaData: Metadata;
+    seoMetaData: ISEOMetaData;
+}
+
+interface IPodcastEpisode extends BaseEntity {
+    title: string;
+    slug: string;
+    summary: string;
+    showNotes: string;
+    transcript: string;
+    audioUrl: string;
+    artwork: string;
+    durationSeconds: number;
+    episodeNumber: number | null;
+    seasonNumber: number | null;
+    publishedAt: Date | string | null;
+    externalUrl: string;
+    guid: string;
+    relatedProducts: unknown[];
+    stores: IStore[];
+    status: boolean;
+    isOnline: boolean;
+    metaData: Metadata;
+    seoMetaData: ISEOMetaData;
+}
+
 interface CheckoutAddressInput {
     addressLine1: string;
     addressLine2?: string;
@@ -1014,4 +1327,4 @@ interface IWishlist extends BaseEntity {
     items: IWishlistItem[];
 }
 
-export { ACTIVE_SUBSCRIPTION_CHANNELS, ADMIN_ROLES, type AddonAmountInput, type AddonSelectionRef, type ApiResponse, type BaseEntity, CAMPAIGN_RECIPIENT_STATUS_VALUES, CAMPAIGN_STATUS_VALUES, CART_STATUS_VALUES, CampaignRecipientStatusEnum, CampaignStatusEnum, CartStatusEnum, type CheckoutAddressInput, type CheckoutPayload, type CheckoutResult, DEFAULT_SUBSCRIPTION_TOPICS, DiscountTypeEnum, EMAIL_TEMPLATE_EVENT_VALUES, EMAIL_TEMPLATE_VARIABLES_BY_EVENT, EmailTemplateEventEnum, FEE_APPLIES_TO_VALUES, FeeAppliesToEnum, type IAddonConfig, type IAddonGroup, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IAppliedFee, type IBannerSlide, type IBrand, type ICampaign, type ICampaignRecipient, type ICampaignStats, type ICart, type ICartItem, type ICategory, type ICompliance, type IContact, type IContent, type ICountry, type ICoupon, type ICurrency, type ICustomer, type IDiscountType, type IDocumentation, type IEmailTemplate, type IKeyValue, type ILinePricing, type IMediaAsset, INVENTORY_POLICY_VALUES, type INotification, type IOrder, type IOrderItem, type IOrderLog, type IOrderTracking, type IOrderTransaction, type IPaymentLink, type IPrice, type IProduct, type IProductDailyStat, type IProductOptionGroup, type IProductOptionValue, type IProductRelationGroup, type IProductTechnicalSpec, type IProductTechnicalSpecTable, type IProductVariantFields, type IProductVariantOptionGroup, type IProductVariantOptionMatrix, type IProductVariantOptionValue, type IRedirect, type IRedirectSuggestion, type IRefundTransaction, type IRelationGroup, type ISEOMetaData, type ISelectableFee, type IShipFromAddress, type IShipping, type IShippingRate, type IState, type IStock, type IStore, type IStoreFee, type IStoreSettings, type ISubscriber, type ISubscriberConsent, type ISubscription, type ISummaryPricing, type ITechSpec, type ITechnicalSpecColumn, type ITechnicalSpecGroup, type ITransactionBase, type IUnmatched404, type IVariant, type IVariantOptionSelection, type IWishlist, type IWishlistItem, type Id, type InventoryPolicy, InventoryPolicyEnum, type Metadata, NOTIFICATION_TYPE_VALUES, NotificationTypeEnum, ORDER_LOG_TYPE_VALUES, ORDER_STATUS_VALUES, OrderLogTypeEnum, OrderStatusEnum, PAYMENT_GATEWAY_VALUES, PAYMENT_LINK_STATUS_VALUES, PAYMENT_METHOD_VALUES, PAYMENT_STATUS_VALUES, PRICING_TYPE_VALUES, PRODUCT_EVENT_TYPE_VALUES, type Paginated, PaymentGatewayEnum, PaymentLinkStatusEnum, PaymentMethodEnum, PaymentStatusEnum, type PricingType, PricingTypeEnum, type ProductAddonScope, ProductEventTypeEnum, type ProductVariantType, RETIRED_CART_STATUSES, type RedirectTargetType, type ResolvedAddonSelection, SUBSCRIPTION_CHANNEL_VALUES, SUBSCRIPTION_TOPIC_LABELS, SUBSCRIPTION_TOPIC_VALUES, type SoftDeleteFilter, type StockStatus, SubscriptionChannelEnum, SubscriptionTopicEnum, TRANSACTION_TYPE_VALUES, TransactionTypeEnum, type VariantOptionMode, WIRED_EMAIL_TEMPLATE_EVENTS, addonUnitAmount, addonsUnitAmount, formatMoney, groupHasDefaultAddon, normalizeLineQuantity, normalizePath, notificationTypeColorMap, orderLogTypeColorMap, paymentGatewayColorMap, paymentLinkStatusColorMap, paymentMethodColorMap, paymentStatusColorMap, resolveAddonSelections, resolveProductAddonGroups, roundMoney, statusColors, typeColorMap };
+export { ACTIVE_SUBSCRIPTION_CHANNELS, ADMIN_ROLES, type AddonAmountInput, type AddonSelectionRef, type ApiResponse, type BaseEntity, type BundleGroup, type BundleLine, CAMPAIGN_RECIPIENT_STATUS_VALUES, CAMPAIGN_STATUS_VALUES, CART_STATUS_VALUES, CONFIGURATOR_CONDITION_TYPE_VALUES, CONFIGURATOR_EFFECT_TYPE_VALUES, CONFIGURATOR_ERROR_CODE_VALUES, CONFIGURATOR_SELECT_MODE_VALUES, CONFIGURATOR_SOURCE_VALUES, CampaignRecipientStatusEnum, CampaignStatusEnum, CartStatusEnum, type CheckoutAddressInput, type CheckoutPayload, type CheckoutResult, ConfiguratorConditionTypeEnum, ConfiguratorEffectTypeEnum, ConfiguratorErrorCodeEnum, type ConfiguratorEvalContext, type ConfiguratorEvalError, type ConfiguratorEvalResult, ConfiguratorSelectModeEnum, type ConfiguratorSelections, ConfiguratorSourceEnum, DEFAULT_SUBSCRIPTION_TOPICS, DiscountTypeEnum, EMAIL_TEMPLATE_EVENT_VALUES, EMAIL_TEMPLATE_VARIABLES_BY_EVENT, EmailTemplateEventEnum, FEE_APPLIES_TO_VALUES, FeeAppliesToEnum, type IAddonConfig, type IAddonGroup, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IAppliedFee, type IBannerSlide, type IBlogAuthor, type IBlogCategory, type IBlogCitation, type IBlogPost, type IBrand, type ICampaign, type ICampaignRecipient, type ICampaignStats, type ICart, type ICartItem, type ICategory, type ICompliance, type IConfigurator, type IConfiguratorCondition, type IConfiguratorEffect, type IConfiguratorFacet, type IConfiguratorFacetValue, type IConfiguratorOption, type IConfiguratorPriceAdjustment, type IConfiguratorQuery, type IConfiguratorRule, type IConfiguratorSection, type IConfiguratorStep, type IConfiguratorTarget, type IContact, type IContent, type ICountry, type ICoupon, type ICurrency, type ICustomer, type IDiscountType, type IDocumentation, type IEmailTemplate, type IKeyValue, type ILinePricing, type IMediaAsset, INVENTORY_POLICY_VALUES, type INotification, type IOrder, type IOrderItem, type IOrderLog, type IOrderTracking, type IOrderTransaction, type IPaymentLink, type IPodcastEpisode, type IPrice, type IProduct, type IProductDailyStat, type IProductOptionGroup, type IProductOptionValue, type IProductRelationGroup, type IProductTechnicalSpec, type IProductTechnicalSpecTable, type IProductVariantFields, type IProductVariantOptionGroup, type IProductVariantOptionMatrix, type IProductVariantOptionValue, type IRedirect, type IRedirectSuggestion, type IRefundTransaction, type IRelationGroup, type ISEOMetaData, type ISelectableFee, type IShipFromAddress, type IShipping, type IShippingRate, type IState, type IStock, type IStore, type IStoreFee, type IStoreSettings, type ISubscriber, type ISubscriberConsent, type ISubscription, type ISummaryPricing, type ITechSpec, type ITechnicalSpecColumn, type ITechnicalSpecGroup, type ITransactionBase, type IUnmatched404, type IVariant, type IVariantOptionSelection, type IWishlist, type IWishlistItem, type Id, type InventoryPolicy, InventoryPolicyEnum, MAX_BUNDLE_QUANTITY, type Metadata, NOTIFICATION_TYPE_VALUES, NotificationTypeEnum, ORDER_LOG_TYPE_VALUES, ORDER_STATUS_VALUES, OrderLogTypeEnum, OrderStatusEnum, PAYMENT_GATEWAY_VALUES, PAYMENT_LINK_STATUS_VALUES, PAYMENT_METHOD_VALUES, PAYMENT_STATUS_VALUES, PRICING_TYPE_VALUES, PRODUCT_EVENT_TYPE_VALUES, type Paginated, PaymentGatewayEnum, PaymentLinkStatusEnum, PaymentMethodEnum, PaymentStatusEnum, type PricingType, PricingTypeEnum, type ProductAddonScope, ProductEventTypeEnum, type ProductVariantType, RETIRED_CART_STATUSES, type RedirectTargetType, type ResolvedAddonSelection, SUBSCRIPTION_CHANNEL_VALUES, SUBSCRIPTION_TOPIC_LABELS, SUBSCRIPTION_TOPIC_VALUES, type SoftDeleteFilter, type StockDemandLine, type StockStatus, type StockVerdict, SubscriptionChannelEnum, SubscriptionTopicEnum, TRANSACTION_TYPE_VALUES, TransactionTypeEnum, type VariantOptionMode, WIRED_EMAIL_TEMPLATE_EVENTS, addonUnitAmount, addonsUnitAmount, adjustmentsFor, applyPriceAdjustments, bundleGroupsOf, bundleLineQuantity, bundleUnitFrom, canonicalizePath, canonicalizeSlug, conditionHolds, demandByKey, evaluateConfigurator, formatMoney, groupHasDefaultAddon, isConfigurationValid, normalizeBundleQuantity, normalizeLineQuantity, normalizePath, notificationTypeColorMap, orderByBundle, orderLogTypeColorMap, paymentGatewayColorMap, paymentLinkStatusColorMap, paymentMethodColorMap, paymentStatusColorMap, resolveAddonSelections, resolveProductAddonGroups, roundMoney, statusColors, stockVerdict, typeColorMap };