@infigo-official/types-for-pricing-script 1.0.2 → 1.0.3

package/v1/{Core → OrderItem}/Tier.d.ts

@@ -1,13 +1,11 @@
 /**
- * This module provides access to tier-based pricing functionality in pricing scripts.
+ * Tier-based pricing functionality for pricing scripts.
  * The tier system supports sophisticated quantity-based pricing models that can
  * account for quantity discounts and customer-specific pricing including:
  * - Quantity-based pricing tiers
  * - Customer role-specific pricing
  * - Volume discount calculations
  * - Tier boundary management
- * 
- * @module Item / Tier
  */
 
 /**
@@ -21,19 +19,6 @@
  * role-based pricing strategies.
  */
 declare interface Tier {
-    /**
-     * The quantity threshold for this tier.
-     * This value represents the minimum quantity required to qualify
-     * for this pricing tier. When the order quantity meets or exceeds
-     * this threshold, the tier's price is applied.
-     * 
-     * @example
-     * if (Item.Quantity >= tier.Quantity) {
-     *     return tier.Price; // Use tier pricing
-     * }
-     */
-    Quantity: number;
-
     /**
      * The price for this tier.
      * This value represents the unit price that applies when the order
@@ -46,6 +31,19 @@ declare interface Tier {
      * }
      */
     Price: number;
+    
+    /**
+     * The quantity threshold for this tier.
+     * This value represents the minimum quantity required to qualify
+     * for this pricing tier. When the order quantity meets or exceeds
+     * this threshold, the tier's price is applied.
+     * 
+     * @example
+     * if (Item.Quantity >= tier.Quantity) {
+     *     return tier.Price; // Use tier pricing
+     * }
+     */
+    Quantity: number;
 
     /**
      * The customer role system name that this tier applies to.

package/v1/{Core → OrderItem}/Version.d.ts

@@ -1,13 +1,11 @@
 /**
- * This module provides access to version management functionality in pricing scripts.
+ * Version management functionality for pricing scripts.
  * The version system supports job versioning information including quantities
  * and custom names, useful for tracking pricing changes across job iterations including:
  * - Individual version information
  * - Version collection management
  * - Quantity tracking across versions
  * - Version status and metadata
- * 
- * @module Item / Version
  */
 
 /**

package/v1/SessionItem/Session.d.ts

@@ -0,0 +1,128 @@
+/**
+ * This module provides access to session-based functionality in pricing scripts.
+ * The Session object represents session-level data and provides access to customer
+ * information and shopping cart items at the session level including:
+ * - Customer session information
+ * - Shopping cart items across the session
+ * - Session-level customer data access
+ * 
+ * @module SessionItem
+ */
+
+/**
+ * The session object available in pricing scripts.
+ * Represents session-level data and provides access to customer information
+ * and shopping cart items that are available during the current session.
+ * 
+ * This object provides session-wide context for pricing calculations that
+ * may need to consider multiple items or customer session data.
+ */
+declare interface Session {
+    /**
+     * Array of shopping cart items in the current session.
+     * Contains all active shopping cart items for the current customer session.
+     * Each item provides full access to product information, attributes, and pricing data.
+     * 
+     * @example
+     * console("Session has " + Session.CartItems.length + " items");
+     * for (var i = 0; i < Session.CartItems.length; i++) {
+     *     var item = Session.CartItems[i];
+     *     console("Item: " + item.ProductName + " - $" + item.Price);
+     * }
+     */
+    CartItems: Item[];
+
+    /**
+     * Alias for CartItems - array of other order items in the session.
+     * Provides the same functionality as CartItems for backward compatibility.
+     * 
+     * @example
+     * var totalSessionValue = 0;
+     * for (var i = 0; i < Session.OtherOrderItems.length; i++) {
+     *     totalSessionValue += Session.OtherOrderItems[i].Price * Session.OtherOrderItems[i].Quantity;
+     * }
+     * console("Total session cart value: $" + totalSessionValue);
+     */
+    OtherOrderItems: Item[];
+
+    /**
+     * Customer email address for the current session.
+     * Provides access to the customer's email address associated with the session.
+     * 
+     * @example
+     * console("Session customer email: " + Session.Email);
+     * if (Session.Email.endsWith(".edu")) {
+     *     console("Educational customer detected");
+     * }
+     */
+    Email: string;
+
+    /**
+     * Array of customer role system names for the current session.
+     * Contains all roles assigned to the customer in the current session.
+     * Used for role-based pricing and access control.
+     * 
+     * @example
+     * console("Customer roles: " + Session.CustomerRoles.join(", "));
+     * if (Session.CustomerRoles.includes("VIP")) {
+     *     console("VIP customer - apply special pricing");
+     * }
+     */
+    CustomerRoles: string[];
+
+    /**
+     * Department name of the customer for the current session.
+     * Represents the department or organizational unit the customer belongs to.
+     * Used for department-specific pricing and business logic.
+     * 
+     * @example
+     * console("Customer department: " + Session.Department);
+     * if (Session.Department === "Education") {
+     *     console("Educational department - apply academic discount");
+     * }
+     */
+    Department: string;
+}
+
+/**
+ * Global Session object available in pricing scripts.
+ * This constant provides access to session-level data and functionality,
+ * allowing scripts to access customer session information and shopping cart data
+ * across the entire session context.
+ * 
+ * The Session object is particularly useful for pricing scripts that need to:
+ * - Consider multiple items in the cart for volume discounts
+ * - Apply session-level customer information
+ * - Implement cross-item pricing logic
+ * - Access customer roles and department information
+ * 
+ * @example
+ * // Check if customer has multiple items for volume pricing
+ * if (Session.CartItems.length > 1) {
+ *     console("Multiple items in cart - check for volume discounts");
+ *     var cartTotal = 0;
+ *     for (var i = 0; i < Session.CartItems.length; i++) {
+ *         cartTotal += Session.CartItems[i].Price * Session.CartItems[i].Quantity;
+ *     }
+ *     
+ *     if (cartTotal > 500) {
+ *         console("Cart total over $500 - apply volume discount");
+ *     }
+ * }
+ * 
+ * // Apply role-based session pricing
+ * if (Session.CustomerRoles.includes("Wholesale")) {
+ *     console("Wholesale customer session - apply wholesale pricing");
+ * }
+ * 
+ * // Department-specific session logic
+ * if (Session.Department === "Marketing") {
+ *     console("Marketing department session - apply marketing discounts");
+ * }
+ * 
+ * // Customer email-based logic
+ * if (Session.Email.includes("@company.com")) {
+ *     console("Internal company customer - apply employee pricing");
+ * }
+ */
+declare const Session: Session;

package/v1/index.d.ts

@@ -1,8 +1,10 @@
-/// <reference path="Core/Item.d.ts" />
-/// <reference path="Core/Attribute.d.ts" />
-/// <reference path="Core/Tier.d.ts" />
-/// <reference path="Core/Version.d.ts" />
+/// <reference path="OrderItem/Item.d.ts" />
+/// <reference path="OrderItem/Attribute.d.ts" />
+/// <reference path="OrderItem/Tier.d.ts" />
+/// <reference path="OrderItem/Version.d.ts" />
 /// <reference path="File/FileInfo.d.ts" />
 /// <reference path="Configuration/Configuration.d.ts" />
 /// <reference path="Output/Output.d.ts" />
-/// <reference path="Helpers/index.d.ts" />
+/// <reference path="Helpers/Helpers.d.ts" />
+/// <reference path="SessionItem/Session.d.ts" />
+/// <reference path="CheckoutItem/CheckoutItem.d.ts" />

package/v1/Core/Item.d.ts

@@ -1,403 +0,0 @@
-/**
- * This module provides access to the main item object in pricing scripts.
- * The Item interface represents the product variant being priced and contains all
- * the essential information needed for pricing calculations including:
- * - Product pricing information (base price, special prices, costs)
- * - Product details (SKU, name, categories, dimensions)
- * - Quantity and packaging information
- * - Attribute management and pricing adjustments
- * - File handling capabilities
- * - Tier-based pricing support
- * 
- * @module Item
- */
-
-/**
- * The main item object available in pricing scripts.
- * Represents the product variant being priced and provides access to all
- * product information, attributes, pricing data, and methods for file handling
- * and attribute management.
- * 
- * This object is the primary interface for accessing product data and performing
- * pricing calculations in pricing scripts.
- */
-declare interface Item {
-    /**
-     * The standard product variant price in the base currency.
-     * This is the base price before any attribute adjustments, tier pricing,
-     * or special pricing is applied.
-     * 
-     * @example
-     * var basePrice = Item.Price;
-     * var adjustedPrice = basePrice * 1.2; // 20% markup
-     */
-    Price: number;
-
-    /**
-     * The old price from the product variant, typically used for displaying
-     * price comparisons or discounts. This value represents the previous
-     * price before any recent price changes.
-     * 
-     * @example
-     * if (Item.OldPrice > Item.Price) {
-     *     var discount = Item.OldPrice - Item.Price;
-     *     return "Save $" + discount.toFixed(2);
-     * }
-     */
-    OldPrice: number;
-
-    /**
-     * The product cost, representing the actual cost to produce or acquire
-     * the product. This value is used for margin calculations and profit analysis.
-     * 
-     * @example
-     * var margin = Item.Price - Item.ProductCost;
-     * var marginPercentage = (margin / Item.Price) * 100;
-     */
-    ProductCost: number;
-
-    /**
-     * The special price for the product variant, if applicable.
-     * This value is null if no special pricing is currently active.
-     * Special pricing typically overrides the standard price for promotional periods.
-     * 
-     * @example
-     * var finalPrice = Item.SpecialPrice || Item.Price;
-     */
-    SpecialPrice: number | null;
-
-    /**
-     * The start date for special pricing, if applicable.
-     * This value is null if no special pricing is currently active.
-     * Used to determine if special pricing should be applied based on current date.
-     * 
-     * @example
-     * var now = new Date();
-     * if (Item.SpecialPriceStartDate && now >= Item.SpecialPriceStartDate) {
-     *     return Item.SpecialPrice;
-     * }
-     */
-    SpecialPriceStartDate: Date | null;
-
-    /**
-     * The end date for special pricing, if applicable.
-     * This value is null if no special pricing is currently active.
-     * Used to determine if special pricing should be applied based on current date.
-     * 
-     * @example
-     * var now = new Date();
-     * if (Item.SpecialPriceEndDate && now <= Item.SpecialPriceEndDate) {
-     *     return Item.SpecialPrice;
-     * }
-     */
-    SpecialPriceEndDate: Date | null;
-
-    /**
-     * Additional shipping charge for this specific product variant.
-     * This value is added to the base shipping cost and represents
-     * any extra shipping fees specific to this item.
-     * 
-     * @example
-     * var totalShipping = baseShippingCost + Item.AdditionalShippingCharge;
-     */
-    AdditionalShippingCharge: number;
-
-    /**
-     * The weight of the item in the configured weight unit (typically grams or ounces).
-     * This value is used for shipping calculations and weight-based pricing.
-     * 
-     * @example
-     * var shippingCost = calculateShippingByWeight(Item.Weight);
-     */
-    Weight: number;
-
-    /**
-     * Indicates whether the weight can be set or modified for this item.
-     * Some products may have fixed weights that cannot be changed,
-     * while others allow weight adjustments based on attributes or custom settings.
-     * 
-     * @example
-     * if (Item.CanSetWeight) {
-     *     // Allow weight adjustments in the UI
-     * }
-     */
-    CanSetWeight: boolean;
-
-    /**
-     * The Stock Keeping Unit (SKU) of the product variant.
-     * This is the unique identifier for the product variant and is used
-     * for inventory management and order processing.
-     * 
-     * @example
-     * var productIdentifier = Item.Sku;
-     */
-    Sku: string;
-
-    /**
-     * The actual SKU based on the current attribute combination.
-     * If no attributes are selected, this will be the same as the product SKU.
-     * This value reflects the specific configuration of the product being priced.
-     * 
-     * @example
-     * var configuredSku = Item.ActualSku;
-     */
-    ActualSku: string;
-
-    /**
-     * The width of the item in the configured dimension unit (typically inches or centimeters).
-     * This value is used for packaging calculations and dimensional pricing.
-     * 
-     * @example
-     * var packagingCost = calculatePackagingCost(Item.Width, Item.Height, Item.Length);
-     */
-    Width: number;
-
-    /**
-     * The height of the item in the configured dimension unit (typically inches or centimeters).
-     * This value is used for packaging calculations and dimensional pricing.
-     * 
-     * @example
-     * var packagingCost = calculatePackagingCost(Item.Width, Item.Height, Item.Length);
-     */
-    Height: number;
-
-    /**
-     * The length of the item in the configured dimension unit (typically inches or centimeters).
-     * This value is used for packaging calculations and dimensional pricing.
-     * 
-     * @example
-     * var packagingCost = calculatePackagingCost(Item.Width, Item.Height, Item.Length);
-     */
-    Length: number;
-
-    /**
-     * The name of the product as displayed to customers.
-     * This is the human-readable product name used in the user interface
-     * and order confirmations.
-     * 
-     * @example
-     * var displayName = Item.ProductName;
-     */
-    ProductName: string;
-
-    /**
-     * Array of category names that this product belongs to.
-     * Categories are used for product organization, filtering, and
-     * category-specific pricing rules.
-     * 
-     * @example
-     * if (Item.Categories.includes("Premium")) {
-     *     return Item.Price * 1.1; // 10% premium markup
-     * }
-     */
-    Categories: string[];
-
-    /**
-     * The order quantity for this item.
-     * This represents how many units of this product variant are being ordered.
-     * Used for quantity-based pricing and tier calculations.
-     * 
-     * @example
-     * var tier = HelperMethods.FindTier(Item.Quantity, Item.PricingTiers);
-     */
-    Quantity: number;
-
-    /**
-     * The pack quantity, calculated as the order quantity divided by the product variant's
-     * OrderPackQuantity. This represents how many packs are being ordered.
-     * 
-     * @example
-     * var packPrice = Item.Price * Item.PackQuantity;
-     */
-    PackQuantity: number;
-
-    /**
-     * The quantity selector mode for this product.
-     * This determines how quantity selection is handled in the user interface
-     * and affects pricing calculations.
-     * 
-     * @example
-     * switch (Item.QuantitySelectorMode) {
-     *     case 1: // Individual units
-     *         return Item.Price * Item.Quantity;
-     *     case 2: // Packs
-     *         return Item.Price * Item.PackQuantity;
-     * }
-     */
-    QuantitySelectorMode: number;
-
-    /**
-     * Whether this is a batch job
-     */
-    IsBatch: boolean;
-
-    /**
-     * Number of pages (-1 if not valid)
-     */
-    NumberOfPages: number;
-
-    /**
-     * Number of records (-1 if not valid)
-     */
-    NumberOfRecords: number;
-
-    /**
-     * Array of pricing tiers with Price, Quantity, and CustomerRole
-     */
-    PricingTiers: Tier[];
-
-    /**
-     * Array of batch tiers (same as PricingTiers but for batch tier table)
-     */
-    BatchTiers: Tier[];
-
-    /**
-     * Price per record (-1 if not valid)
-     */
-    PricePerRecord: number;
-
-    /**
-     * Array of attributes with Key, Value, IsRequired, Prompt, PriceAdjustment, etc.
-     */
-    Attributes: Attribute[];
-
-    /**
-     * User email
-     */
-    Email: string;
-
-    /**
-     * Array of customer role system names
-     */
-    CustomerRoles: string[];
-
-    /**
-     * Department name of user
-     */
-    Department: string;
-
-    /**
-     * Array of other order items using the same custom pricing script
-     */
-    OtherOrderItems: Item[];
-
-    /**
-     * Alias of OtherOrderItems
-     */
-    CartItems: Item[];
-
-    /**
-     * Index of this item in the other order item array (0 if not in array)
-     */
-    OrderItemIndex: number;
-
-    /**
-     * Index of this item in the other order item array (-1 if not in array)
-     */
-    CartItemIndex: number;
-
-    /**
-     * Whether this item is in the other order item array
-     */
-    IsInOtherOrderItems: boolean;
-
-    /**
-     * Value of the currently used discount code
-     */
-    DiscountCode: string;
-
-    /**
-     * Array of versions with JobId, CustomName, and Quantity
-     */
-    Versions: ItemVersion[];
-
-    /**
-     * Number of versions
-     */
-    NumberOfVersions: number;
-
-    /**
-     * Whether this is a version of a job
-     */
-    IsVersion: boolean;
-
-    /**
-     * Sum of all quantities of all versions
-     */
-    VersionsSumQuantity: number;
-
-    /**
-     * Get file information for attached files
-     * @param attributeId - ID of the attribute
-     * @param readContent - Whether to read file content
-     * @returns FileInfo object
-     */
-    getFileInfo(attributeId: string, readContent: boolean): FileInfo;
-
-    /**
-     * Shortcut method to retrieve an attribute value by name
-     * @param attribute - Name of the attribute
-     * @returns Attribute value
-     */
-    getAttributeValue(attribute: string): string;
-
-    /**
-     * Set the attribute value permanently to the given value
-     * @param attribute - Name of the attribute
-     * @param value - Value to set
-     */
-    setAttributeValue(attribute: string, value: string): void;
-
-    /**
-     * Get file information for a specific configurable file from Global Data
-     * @param filename - Name of the file
-     * @returns FileInfo object
-     */
-    getGlobalFileContent(filename: string): FileInfo;
-}
-
-/**
- * Global Item object available in pricing scripts
- * This constant provides access to all item-related data and functionality,
- * allowing scripts to retrieve product information, pricing data, attributes,
- * and perform various operations on the current item being priced.
- * 
- * The Item object contains comprehensive information about the product variant
- * including pricing details, attributes, customer information, file attachments,
- * and methods for data manipulation and file handling.
- * 
- * @example
- * // Access basic product information
- * var productName = Item.ProductName;
- * var basePrice = Item.Price;
- * var quantity = Item.Quantity;
- * 
- * // Work with attributes
- * for (var i = 0; i < Item.Attributes.length; i++) {
- *     var attr = Item.Attributes[i];
- *     debug("Attribute: " + attr.Key + " = " + attr.Value);
- * }
- * 
- * // Get file information
- * var fileInfo = Item.getFileInfo("fileAttributeId", true);
- * if (fileInfo.NumberOfPages > 0) {
- *     debug("File has " + fileInfo.NumberOfPages + " pages");
- * }
- * 
- * // Access customer information
- * if (Item.CustomerRoles.indexOf("VIP") >= 0) {
- *     // Apply VIP pricing logic
- * }
- * 
- * // Work with pricing tiers
- * var tier = HelperMethods.FindTier(Item.Quantity, Item.PricingTiers, Item.CustomerRoles);
- * if (tier) {
- *     debug("Using tier: " + tier.Quantity + " @ $" + tier.Price);
- * }
- * 
- * // Calculate final price
- * var finalPrice = Item.Price;
- * finalPrice += HelperMethods.GetAttributePriceAdjustment(Item.Quantity, Item.CustomerRoles);
- * return finalPrice;
- */
-declare const Item: Item;