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

package/README.md

@@ -2,7 +2,7 @@
 
 Type definitions for the Pricing Script scripting interface.
 
-Full documentation is available [here](https://infigo-official.github.io/types-for-pricing-script/).
+Full documentation is available [here](https://infigo-official.github.io/types-for-pricing-scripts/).
 
 Use and install the package to get the best experience and IntelliSense support within our IDE.
 Choose dev dependencies if you are developing in Javascript or our code will not be reused in another project.

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "@infigo-official/types-for-pricing-script",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Type definitions for Pricing Script Scripting",
   "types": "v1/index.d.ts",
   "devDependencies": {
-    "typedoc": "^0.26.6",
-    "typescript": "^5.5.4"
+    "typedoc": "^0.24.8",
+    "typescript": "^4.9.5"
   },
   "scripts": {
-    "docs": "npx typedoc"
+    "docs": "npx typedoc",
+    "start": "npx http-server docs -p 3000 -o"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Infigo-Official/types-for-pricing-script.git"
+    "url": "git+https://github.com/Infigo-Official/types-for-pricing-scripts.git"
   },
   "keywords": [
     "typedefinitions",
@@ -22,9 +23,9 @@
   "author": "Infigo",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/Infigo-Official/types-for-pricing-script/issues"
+    "url": "https://github.com/Infigo-Official/types-for-pricing-scripts/issues"
   },
-  "homepage": "https://github.com/Infigo-Official/types-for-pricing-script#readme",
+  "homepage": "https://github.com/Infigo-Official/types-for-pricing-scripts#readme",
   "files": [
     "v1",
     "package.json",

package/v1/{System → Configuration}/Configuration.d.ts

@@ -7,7 +7,7 @@
  * - Custom configuration data
  * - System-wide settings
  * 
- * @module System / Configuration
+ * @module Configuration
  */
 
 /**
@@ -45,4 +45,6 @@ declare interface ConfigurationInterface {
  * var scriptConfig = Configuration.ScriptConfig;
  * var customSetting = scriptConfig.customParameter;
  */
-declare const Configuration: ConfigurationInterface; 
+declare const Configuration: ConfigurationInterface;
+
+

package/v1/{Item → Core}/Item.d.ts

@@ -357,6 +357,47 @@ declare interface Item {
 }
 
 /**
- * Global Item object
+ * 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; 

package/v1/Helpers/index.d.ts

@@ -0,0 +1,261 @@
+/**
+ * This module provides utility functions for common pricing calculations and data manipulation tasks.
+ * Helper methods make it easier to write complex pricing logic by providing pre-built functionality
+ * for common operations including:
+ * - Tier-based pricing calculations
+ * - Attribute price adjustments
+ * - Price interpolation between tiers
+ * - CSV data parsing and manipulation
+ * - Object manipulation and debugging utilities
+ * 
+ * @module Helper / HelperMethods
+ */
+
+/**
+ * CSV parsing options for configuring CSV parsing behavior
+ */
+declare interface CsvOptions {
+    /**
+     * Delimiter character used to separate fields in CSV (default: ",")
+     */
+    delimiterChar?: string;
+
+    /**
+     * Quote character used to enclose fields containing delimiters (default: '"')
+     */
+    quoteChar?: string;
+
+    /**
+     * Whether to disable automatic number conversion (default: false)
+     * When true, all values remain as strings
+     */
+    disableNumberConverstion?: boolean;
+}
+
+/**
+ * CSV replacer function type for custom value transformation during stringify operations
+ * @param row - Row index (0-based)
+ * @param col - Column index (0-based)
+ * @param value - Current value to transform
+ * @returns Transformed value
+ */
+declare type CsvReplacer = (row: number, col: number, value: any) => any;
+
+/**
+ * CSV stringify options for configuring CSV output format
+ */
+declare interface CsvStringifyOptions {
+    /**
+     * Delimiter character used to separate fields in output CSV (default: ",")
+     */
+    delimiterChar?: string;
+
+    /**
+     * Quote character used to enclose fields containing delimiters (default: '"')
+     */
+    quoteChar?: string;
+
+    /**
+     * Replacer function for custom value transformation during stringify
+     */
+    replacer?: CsvReplacer;
+}
+
+/**
+ * CSV helper methods for parsing and stringifying CSV data
+ * Provides utilities for working with CSV files and data in pricing scripts
+ */
+declare interface CsvHelper {
+    /**
+     * Parse CSV string into array of arrays
+     * Converts CSV text data into a structured format for processing in pricing scripts
+     * 
+     * @param csv - CSV string to parse
+     * @param options - Parsing options to configure delimiter, quote character, etc.
+     * @param disableNumberConversion - Whether to disable automatic number conversion
+     * @returns Array of arrays representing the CSV data, where each inner array is a row
+     * 
+     * @example
+     * var csvData = HelperMethods.CSV.parse("1,Product A,10.99\n2,Product B,15.50");
+     * // Result: [["1", "Product A", "10.99"], ["2", "Product B", "15.50"]]
+     */
+    parse(csv: string, options?: CsvOptions, disableNumberConversion?: boolean): any[][];
+
+    /**
+     * Convert array of arrays to CSV string
+     * Converts structured data back to CSV format for output or file generation
+     * 
+     * @param table - Array of arrays to convert, where each inner array is a row
+     * @param options - Stringify options to configure output format
+     * @returns CSV string representation of the data
+     * 
+     * @example
+     * var data = [["1", "Product A", "10.99"], ["2", "Product B", "15.50"]];
+     * var csvString = HelperMethods.CSV.stringify(data);
+     * // Result: "1,Product A,10.99\n2,Product B,15.50"
+     */
+    stringify(table: any[][], options?: CsvStringifyOptions): string;
+}
+
+/**
+ * Helper methods available in pricing scripts for common calculations and data manipulation
+ * These utilities extend the capabilities of pricing scripts and help create more flexible
+ * and maintainable pricing logic.
+ */
+declare interface HelperMethods {
+    /**
+     * Find appropriate pricing tier based on quantity and customer roles
+     * Searches through tier arrays to find the best matching tier for the given quantity
+     * and customer roles, supporting both regular pricing tiers and batch tiers
+     * 
+     * @param quantity - The quantity which you would like the price to be worked out based on
+     * @param tiers - An array of object literals [{Quantity: n, Price: n, CustomerRole?: string}]
+     * @param roles - Array of string that contains customer roles, falls back to Customer.Roles if not supplied
+     * @returns Tier object or null if no matching tier found
+     * 
+     * @example
+     * var tiers = [{Quantity: 1, Price: 5}, {Quantity: 50, Price: 17}, {Quantity: 250, Price: 60}];
+     * var tier = HelperMethods.FindTier(100, tiers, ["SuperAdmin", "Admin"]);
+     * // Returns the tier with Quantity: 50, Price: 17
+     */
+    FindTier(quantity: number, tiers: Tier[], roles?: string[]): Tier | null;
+
+    /**
+     * Get attribute price adjustments including tier-based adjustments
+     * Calculates the total price adjustment for all selected attributes, taking into account
+     * tier-based pricing adjustments that can vary based on quantity or customer roles
+     * 
+     * @param quantity - The quantity which you would like the price to be worked out based on
+     * @param roles - Array of string that contains customer roles, falls back to Customer.Roles if not supplied
+     * @returns Total price adjustment including all attribute and tier adjustments
+     * 
+     * @example
+     * var attributeAdjustment = HelperMethods.GetAttributePriceAdjustment(43, ["SuperAdmin", "Admin"]);
+     * // Returns the total price adjustment for quantity 43 with specified customer roles
+     */
+    GetAttributePriceAdjustment(quantity: number, roles?: string[]): number;
+
+    /**
+     * Interpolate prices between tier boundaries for smooth pricing transitions
+     * Calculates a price that falls between tier boundaries based on the specified quantity,
+     * providing smooth pricing curves rather than step-based pricing
+     * 
+     * @param quantity - The quantity which you would like the price to be worked out based on
+     * @param tiers - An array of object literals [{Quantity: n, Price: n}] for interpolation
+     * @returns Interpolated price based on quantity position within the specified tiers
+     * 
+     * @example
+     * var interpolationTiers = [
+     *   {Quantity: 1, Price: 5}, {Quantity: 50, Price: 17}, 
+     *   {Quantity: 250, Price: 60}, {Quantity: 500, Price: 100}, 
+     *   {Quantity: 1000, Price: 200}
+     * ];
+     * var tierPrice = HelperMethods.InterpolatePrice(Item.Quantity, interpolationTiers);
+     * // Returns interpolated price based on Item.Quantity position within tiers
+     */
+    InterpolatePrice(quantity: number, tiers: Tier[]): number;
+
+    /**
+     * Log object properties for debugging complex pricing scenarios
+     * Outputs all properties of an object to the console for debugging purposes,
+     * useful for examining complex data structures during script development
+     * 
+     * @param data - Object to log all properties from
+     * 
+     * @example
+     * HelperMethods.LogObject(Item);
+     * // Logs all Item properties to console for debugging
+     */
+    LogObject(data: any): void;
+
+    /**
+     * Check if arrays contain specific values for conditional logic
+     * Utility function for checking array membership in conditional pricing logic
+     * 
+     * @param array - Array to check for the specified value
+     * @param value - Value to search for in the array
+     * @returns Whether the value is found in the array
+     * 
+     * @example
+     * if (HelperMethods.Contains(Item.CustomerRoles, "VIP")) {
+     *   // Apply VIP pricing logic
+     * }
+     */
+    Contains(array: any[], value: any): boolean;
+
+    /**
+     * Type checking utility for robust script development
+     * Determines if an item is a plain object (not null, not array, not primitive)
+     * 
+     * @param item - Item to check if it's an object
+     * @returns Whether the item is an object
+     * 
+     * @example
+     * if (HelperMethods.IsObject(config)) {
+     *   // Process configuration object
+     * }
+     */
+    IsObject(item: any): boolean;
+
+    /**
+     * Type checking utility for robust script development
+     * Determines if an item is an array
+     * 
+     * @param item - Item to check if it's an array
+     * @returns Whether the item is an array
+     * 
+     * @example
+     * if (HelperMethods.IsArray(Item.Attributes)) {
+     *   // Process attributes array
+     * }
+     */
+    IsArray(item: any): boolean;
+
+    /**
+     * Deep merge objects with conflict resolution for combining pricing data
+     * Merges source object properties into target object, handling nested objects
+     * and providing a way to combine configuration data from multiple sources
+     * 
+     * @param target - Target object to merge properties into
+     * @param source - Source object to merge properties from
+     * 
+     * @example
+     * var baseConfig = {markup: 20, shipping: 5};
+     * var overrideConfig = {markup: 25};
+     * HelperMethods.MergeObject(baseConfig, overrideConfig);
+     * // baseConfig now has {markup: 25, shipping: 5}
+     */
+    MergeObject(target: any, source: any): void;
+
+    /**
+     * CSV parsing and stringifying utilities for data-driven pricing
+     * Provides comprehensive CSV handling capabilities for working with external data
+     * files, configuration data, and bulk pricing information
+     * 
+     * @example
+     * // Parse CSV file content
+     * var csvContent = HelperMethods.CSV.parse(fileContent);
+     * 
+     * // Generate CSV output
+     * var outputData = [["Product", "Price"], ["Item A", "10.99"]];
+     * var csvOutput = HelperMethods.CSV.stringify(outputData);
+     */
+    CSV: CsvHelper;
+}
+
+/**
+ * Global HelperMethods object available in pricing scripts
+ * This constant provides access to all helper methods and utilities,
+ * allowing scripts to use advanced functionality for complex pricing calculations
+ * 
+ * @example
+ * // Use interpolation for tier-based pricing
+ * var tierPrice = HelperMethods.InterpolatePrice(Item.Quantity, pricingTiers);
+ * 
+ * // Get attribute adjustments
+ * var adjustments = HelperMethods.GetAttributePriceAdjustment(Item.Quantity, Item.CustomerRoles);
+ * 
+ * // Parse CSV data
+ * var data = HelperMethods.CSV.parse(csvString);
+ */
+declare const HelperMethods: HelperMethods; 

package/v1/{System → Output}/Output.d.ts

@@ -8,7 +8,7 @@
  * - Error messages for calculation failures
  * - Console logging for debugging purposes
  * 
- * @module System / Output
+ * @module Output
  */
 
 /**
@@ -71,11 +71,7 @@ declare function error(message: string): void;
  * @param message - The message to log to the console
  * 
  * @example
- * consoleLog("Script execution started");
- * consoleLog("Final calculated price: $" + finalPrice);
+ * console("Script execution started");
+ * console("Final calculated price: $" + finalPrice);
  */
-declare function consoleLog(message: string): void;
-
-
-
- 
+declare function console(message: string): void;

package/v1/index.d.ts

@@ -1,8 +1,8 @@
-/// <reference path="Item/Item.d.ts" />
-/// <reference path="Item/Attribute.d.ts" />
-/// <reference path="Item/Tier.d.ts" />
-/// <reference path="Item/Version.d.ts" />
+/// <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="File/FileInfo.d.ts" />
-/// <reference path="System/Configuration.d.ts" />
-/// <reference path="System/Output.d.ts" />
-/// <reference path="Helper/HelperMethods.d.ts" /> 
+/// <reference path="Configuration/Configuration.d.ts" />
+/// <reference path="Output/Output.d.ts" />
+/// <reference path="Helpers/index.d.ts" />

package/v1/Helper/HelperMethods.d.ts

@@ -1,141 +0,0 @@
-/**
- * CSV parsing options
- */
-declare interface CsvOptions {
-    /**
-     * Delimiter character (default: ",")
-     */
-    delimiterChar?: string;
-
-    /**
-     * Quote character (default: '"')
-     */
-    quoteChar?: string;
-
-    /**
-     * Whether to disable number conversion (default: false)
-     */
-    disableNumberConverstion?: boolean;
-}
-
-/**
- * CSV replacer function for stringify
- */
-declare type CsvReplacer = (row: number, col: number, value: any) => any;
-
-/**
- * CSV stringify options
- */
-declare interface CsvStringifyOptions {
-    /**
-     * Delimiter character (default: ",")
-     */
-    delimiterChar?: string;
-
-    /**
-     * Quote character (default: '"')
-     */
-    quoteChar?: string;
-
-    /**
-     * Replacer function for custom value transformation
-     */
-    replacer?: CsvReplacer;
-}
-
-/**
- * CSV helper methods
- */
-declare interface CsvHelper {
-    /**
-     * Parse CSV string into array of arrays
-     * @param csv - CSV string to parse
-     * @param options - Parsing options
-     * @param disableNumberConversion - Whether to disable number conversion
-     * @returns Array of arrays representing the CSV data
-     */
-    parse(csv: string, options?: CsvOptions, disableNumberConversion?: boolean): any[][];
-
-    /**
-     * Convert array of arrays to CSV string
-     * @param table - Array of arrays to convert
-     * @param options - Stringify options
-     * @returns CSV string
-     */
-    stringify(table: any[][], options?: CsvStringifyOptions): string;
-}
-
-/**
- * Helper methods available in pricing scripts
- */
-declare interface HelperMethods {
-    /**
-     * Find the appropriate tier based on quantity and customer roles
-     * @param quantity - The quantity to find tier for
-     * @param tiers - Array of tier objects
-     * @param roles - Array of customer role system names
-     * @returns Tier object or null if no tier found
-     */
-    FindTier(quantity: number, tiers: Tier[], roles?: string[]): Tier | null;
-
-    /**
-     * Get attribute price adjustments including tier price adjustments
-     * @param quantity - The quantity to get adjustments for
-     * @param roles - Array of customer role system names
-     * @returns Total price adjustment
-     */
-    GetAttributePriceAdjustment(quantity: number, roles?: string[]): number;
-
-    /**
-     * Interpolate price based on quantity and tiers
-     * @param quantity - The quantity to interpolate price for
-     * @param tiers - Array of tier objects
-     * @returns Interpolated price
-     */
-    InterpolatePrice(quantity: number, tiers: Tier[]): number;
-
-    /**
-     * Log all properties of an object to console
-     * @param data - Object to log
-     */
-    LogObject(data: any): void;
-
-    /**
-     * Check if an array contains a specific value
-     * @param array - Array to check
-     * @param value - Value to search for
-     * @returns Whether the value is found
-     */
-    Contains(array: any[], value: any): boolean;
-
-    /**
-     * Check if an item is an object
-     * @param item - Item to check
-     * @returns Whether the item is an object
-     */
-    IsObject(item: any): boolean;
-
-    /**
-     * Check if an item is an array
-     * @param item - Item to check
-     * @returns Whether the item is an array
-     */
-    IsArray(item: any): boolean;
-
-    /**
-     * Merge source object into target object
-     * @param target - Target object to merge into
-     * @param source - Source object to merge from
-     */
-    MergeObject(target: any, source: any): void;
-
-    /**
-     * CSV parsing and stringifying utilities
-     */
-    CSV: CsvHelper;
-}
-
-/**
- * Global HelperMethods object
- */
-declare const HelperMethods: HelperMethods;