@aptos-scp/scp-component-store-selling-features-domain-model 1.28.0 → 1.30.0

package/lib/domain/model/Constants.d.ts

@@ -143,6 +143,7 @@ export declare enum UiInputKey {
     FISCAL_DEVICE_ERROR_DESCRIPTION = "fiscalDeviceErrorDescription",
     FISCAL_DEVICE_INFORMATION = "fiscalDeviceInformation",
     FISCAL_TRANSACTION_INFORMATION = "fiscalTransactionInformation",
+    FISCAL_VARIANCE_INFORMATION = "fiscalVarianceInformation",
     FISCAL_RFECEIPT_AMOUNT = "fiscalReceiptAmount",
     FISCAL_RFECEIPT_DATE = "fiscalReceiptDate",
     FISCAL_RFECEIPT_TIME = "fiscalReceiptTime",
@@ -531,6 +532,7 @@ export declare enum CollectedDataKey {
     FiscalDeviceActivitySuccessful = "fiscalDeviceActivitySuccessful",
     FiscalDeviceInformation = "fiscalDeviceInformation",
     FiscalTransactionInformation = "fiscalTransactionInformation",
+    FiscalVarianceInformation = "FiscalVarianceInformation",
     FiscalDeviceErrorCode = "fiscalDeviceErrorCode",
     FiscalDeviceErrorDescription = "fiscalDeviceErrorDescription",
     ForcedAuthorizationApproval = "ForcedAuthorizationApproval",

package/lib/domain/model/Constants.js

@@ -146,6 +146,7 @@ var UiInputKey;
     UiInputKey["FISCAL_DEVICE_ERROR_DESCRIPTION"] = "fiscalDeviceErrorDescription";
     UiInputKey["FISCAL_DEVICE_INFORMATION"] = "fiscalDeviceInformation";
     UiInputKey["FISCAL_TRANSACTION_INFORMATION"] = "fiscalTransactionInformation";
+    UiInputKey["FISCAL_VARIANCE_INFORMATION"] = "fiscalVarianceInformation";
     UiInputKey["FISCAL_RFECEIPT_AMOUNT"] = "fiscalReceiptAmount";
     UiInputKey["FISCAL_RFECEIPT_DATE"] = "fiscalReceiptDate";
     UiInputKey["FISCAL_RFECEIPT_TIME"] = "fiscalReceiptTime";
@@ -540,6 +541,7 @@ var CollectedDataKey;
     CollectedDataKey["FiscalDeviceActivitySuccessful"] = "fiscalDeviceActivitySuccessful";
     CollectedDataKey["FiscalDeviceInformation"] = "fiscalDeviceInformation";
     CollectedDataKey["FiscalTransactionInformation"] = "fiscalTransactionInformation";
+    CollectedDataKey["FiscalVarianceInformation"] = "FiscalVarianceInformation";
     CollectedDataKey["FiscalDeviceErrorCode"] = "fiscalDeviceErrorCode";
     CollectedDataKey["FiscalDeviceErrorDescription"] = "fiscalDeviceErrorDescription";
     CollectedDataKey["ForcedAuthorizationApproval"] = "ForcedAuthorizationApproval";

package/lib/domain/model/IStoreItemSummary.d.ts

@@ -0,0 +1,4 @@
+export interface IStoreItemSummary {
+    uniqueId: string;
+    imageUrl: string;
+}

package/lib/domain/model/IStoreItemSummary.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IStoreItemSummary.js.map

package/lib/domain/model/StoreItem.js

@@ -7,7 +7,7 @@ const scp_component_store_items_1 = require("@aptos-scp/scp-component-store-item
 const scp_component_store_selling_core_1 = require("@aptos-scp/scp-component-store-selling-core");
 const scp_types_commerce_transaction_1 = require("@aptos-scp/scp-types-commerce-transaction");
 const ErrorCodes_1 = require("../../config/ErrorCodes");
-const utils_1 = require("../utility/utils");
+const utility_1 = require("../utility");
 const logger = scp_component_logging_1.LogManager.getLogger("com.aptos.storesellingfeatures.domain.model.StoreItem");
 var SourceType;
 (function (SourceType) {
@@ -115,7 +115,7 @@ function getProductAttributeTranslation(attribute, locale = "en") {
     if (!attribute.translations) {
         return undefined;
     }
-    const localeToUse = utils_1.getLocaleCodeForTranslationSet(attribute.translations, locale);
+    const localeToUse = utility_1.getLocaleCodeForTranslationSet(attribute.translations, locale);
     let translation = localeToUse && attribute.translations[localeToUse];
     if (!translation) {
         const defaultLocale = "en";
@@ -128,7 +128,7 @@ function getMerchandiseHierarchyNodeNameTranslation(node, locale = "en") {
     if (!node.translations) {
         return { name: node.nodeInLevelId };
     }
-    const localeToUse = utils_1.getLocaleCodeForTranslationSet(node.translations, locale);
+    const localeToUse = utility_1.getLocaleCodeForTranslationSet(node.translations, locale);
     let translation = localeToUse && node.translations[localeToUse];
     if (!translation) {
         const defaultLocale = "en";
@@ -178,7 +178,7 @@ class ColorAttribute {
     constructor(attribute, locale) {
         this.id = attribute.id;
         this.code = attribute.code;
-        const localeCodeToUse = attribute.translations && utils_1.getLocaleCodeForTranslationSet(attribute.translations, locale);
+        const localeCodeToUse = attribute.translations && utility_1.getLocaleCodeForTranslationSet(attribute.translations, locale);
         const translations = localeCodeToUse && attribute.translations[localeCodeToUse];
         if (translations) {
             this.name = translations.name;
@@ -194,7 +194,7 @@ class StyleAttribute {
     constructor(attribute, locale) {
         this.id = attribute.id;
         this.code = attribute.code;
-        const localeCodeToUse = attribute.translations && utils_1.getLocaleCodeForTranslationSet(attribute.translations, locale);
+        const localeCodeToUse = attribute.translations && utility_1.getLocaleCodeForTranslationSet(attribute.translations, locale);
         const translations = localeCodeToUse && attribute.translations[localeCodeToUse];
         if (translations) {
             this.name = translations.name;
@@ -211,7 +211,7 @@ class SizeAttribute {
         this.id = attribute.id;
         this.code = attribute.code;
         this.subcode = attribute.subcode;
-        const localeCodeToUse = attribute.translations && utils_1.getLocaleCodeForTranslationSet(attribute.translations, locale);
+        const localeCodeToUse = attribute.translations && utility_1.getLocaleCodeForTranslationSet(attribute.translations, locale);
         const translations = localeCodeToUse && attribute.translations[localeCodeToUse];
         if (translations) {
             this.name = translations.name;
@@ -355,30 +355,9 @@ class StoreItem {
             storeItem.itemType = item.type && findItemType(item.type);
             //sourceIndicator
             storeItem.source = sourceIndicator;
-            // imageUrl
-            const lineItemImageConfiguration = configurationManager.getFunctionalBehaviorValues().lineItemImage;
-            const getImageUrl = (imageSource) => {
-                switch (imageSource) {
-                    case "ImageFromItemData":
-                        let imageUrl = undefined;
-                        if (item.images && item.images.length > 0) {
-                            const primaryImages = item.images.filter((x) => x.primaryImage === true);
-                            imageUrl = (primaryImages.length > 0 ? primaryImages : item.images)[0].imageUrl;
-                        }
-                        return imageUrl;
-                    case "ImageFromUrlPattern":
-                        let urlPattern = lineItemImageConfiguration.urlPattern;
-                        const aSkuKey = item.lookupKeys.find((aKey) => aKey.keyType === scp_component_store_items_1.KeyType.SKU);
-                        if (aSkuKey) {
-                            urlPattern = urlPattern.replace(/{{SKU}}/g, aSkuKey.value);
-                        }
-                        return urlPattern;
-                    default:
-                        return undefined;
-                }
-            };
-            storeItem.imageUrl = getImageUrl(lineItemImageConfiguration.imageSource);
-            if (lineItemImageConfiguration.imageSource === "ImageFromItemData" &&
+            storeItem.imageUrl = utility_1.getImageUrlForItem(configurationManager, item);
+            if (configurationManager.getFunctionalBehaviorValues().lineItemImage.imageSource ===
+                "ImageFromItemData" &&
                 item.images &&
                 item.images.length > 0) {
                 storeItem.images = item.images;
@@ -698,7 +677,7 @@ class StoreItem {
     static updateLocalizableTextsFromItemAttributeObject(storeItem, sourceItem, locale) {
         let useDefaultValues = true;
         if (!!locale && locale !== sourceItem.language && sourceItem.translations) {
-            const localeToUse = utils_1.getLocaleCodeForTranslationSet(sourceItem.translations, locale);
+            const localeToUse = utility_1.getLocaleCodeForTranslationSet(sourceItem.translations, locale);
             if (localeToUse) {
                 // ... language-specific values
                 const itemTranslationAttribute = sourceItem.translations[localeToUse];

package/lib/domain/model/fiscalDevice/FiscalDeviceStatusLine.d.ts

@@ -10,6 +10,7 @@ export declare class FiscalDeviceStatusLine extends BaseTransactionLine {
     private _transactionLineReference?;
     private _fiscalDeviceInformation?;
     private _fiscalTransactionInformation?;
+    private _fiscalVarianceInformation?;
     /**
      * The create method is called by the transaction line factory to create an instance and initialize it from the
      * data collected during the qualification process.
@@ -29,7 +30,8 @@ export declare class FiscalDeviceStatusLine extends BaseTransactionLine {
     get fiscalDeviceActivityResult(): IDeviceActivityResult;
     get fiscalDeviceInformation(): IFiscalDeviceInformation;
     get fiscalTransactionInformation(): IFiscalTransactionInformation;
-    protected constructor(lineNumber: number, lineType: string, peripheralDeviceId: string, fiscalDeviceActivityResult: IDeviceActivityResult, transactionLineReference?: ITransactionLineReferenceType, fiscalDeviceInformation?: IFiscalDeviceInformation, fiscalTransactionInformation?: IFiscalTransactionInformation);
+    get fiscalVarianceInformation(): IFiscalTransactionInformation;
+    protected constructor(lineNumber: number, lineType: string, peripheralDeviceId: string, fiscalDeviceActivityResult: IDeviceActivityResult, transactionLineReference?: ITransactionLineReferenceType, fiscalDeviceInformation?: IFiscalDeviceInformation, fiscalTransactionInformation?: IFiscalTransactionInformation, fiscalVarianceInformation?: IFiscalTransactionInformation);
     protected newTransactionLine(): BaseTransactionLine;
 }
 export declare function isFiscalDeviceStatusLine(transactionLine: ITransactionLine): transactionLine is FiscalDeviceStatusLine;

package/lib/domain/model/fiscalDevice/FiscalDeviceStatusLine.js

@@ -6,13 +6,14 @@ const Constants_1 = require("../Constants");
 exports.FISCAL_DEVICE_STATUS_LINE_TYPE = "FiscalDeviceStatus";
 class FiscalDeviceStatusLine extends BaseTransactionLine_1.BaseTransactionLine {
     // Since the constructor is only called from the create methods it is made protected to prevent use by others.
-    constructor(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation) {
+    constructor(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation, fiscalVarianceInformation) {
         super(lineNumber, lineType);
         this._peripheralDeviceId = peripheralDeviceId;
         this._fiscalDeviceActivityResult = fiscalDeviceActivityResult;
         this._transactionLineReference = transactionLineReference;
         this._fiscalDeviceInformation = fiscalDeviceInformation;
         this._fiscalTransactionInformation = fiscalTransactionInformation;
+        this._fiscalVarianceInformation = fiscalVarianceInformation;
     }
     /**
      * The create method is called by the transaction line factory to create an instance and initialize it from the
@@ -42,7 +43,8 @@ class FiscalDeviceStatusLine extends BaseTransactionLine_1.BaseTransactionLine {
         const transactionLineReference = collectedData.get(Constants_1.CollectedDataKey.TransactionLineReference);
         const fiscalDeviceInformation = collectedData.get(Constants_1.CollectedDataKey.FiscalDeviceInformation);
         const fiscalTransactionInformation = collectedData.get(Constants_1.CollectedDataKey.FiscalTransactionInformation);
-        const fiscalDeviceStatusLine = new FiscalDeviceStatusLine(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation);
+        const fiscalVarianceInformation = collectedData.get(Constants_1.CollectedDataKey.FiscalVarianceInformation);
+        const fiscalDeviceStatusLine = new FiscalDeviceStatusLine(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation, fiscalVarianceInformation);
         return fiscalDeviceStatusLine;
     }
     static createFromJsonObject(transactionLineJsonObj) {
@@ -53,7 +55,8 @@ class FiscalDeviceStatusLine extends BaseTransactionLine_1.BaseTransactionLine {
         const transactionLineReference = transactionLineJsonObj._transactionLineReference;
         const fiscalDeviceInformation = transactionLineJsonObj._fiscalDeviceInformation;
         const fiscalTransactionInformation = transactionLineJsonObj._fiscalTransactionInformation;
-        const fiscalDeviceStatusLine = new FiscalDeviceStatusLine(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation);
+        const fiscalVarianceInformation = transactionLineJsonObj._fiscalVarianceInformation;
+        const fiscalDeviceStatusLine = new FiscalDeviceStatusLine(lineNumber, lineType, peripheralDeviceId, fiscalDeviceActivityResult, transactionLineReference, fiscalDeviceInformation, fiscalTransactionInformation, fiscalVarianceInformation);
         fiscalDeviceStatusLine.loadFromJsonObject(transactionLineJsonObj);
         return fiscalDeviceStatusLine;
     }
@@ -75,8 +78,11 @@ class FiscalDeviceStatusLine extends BaseTransactionLine_1.BaseTransactionLine {
     get fiscalTransactionInformation() {
         return this._fiscalTransactionInformation;
     }
+    get fiscalVarianceInformation() {
+        return this._fiscalVarianceInformation;
+    }
     newTransactionLine() {
-        return new FiscalDeviceStatusLine(this.lineNumber, this.lineType, this._peripheralDeviceId, this._fiscalDeviceActivityResult, this._transactionLineReference, this._fiscalDeviceInformation, this._fiscalTransactionInformation);
+        return new FiscalDeviceStatusLine(this.lineNumber, this.lineType, this._peripheralDeviceId, this._fiscalDeviceActivityResult, this._transactionLineReference, this._fiscalDeviceInformation, this._fiscalTransactionInformation, this._fiscalVarianceInformation);
     }
 }
 exports.FiscalDeviceStatusLine = FiscalDeviceStatusLine;

package/lib/domain/model/index.d.ts

@@ -107,3 +107,4 @@ export * from "./lottery/";
 export * from "./ITransactionMetadataPersistanceObject";
 export * from "./IReceipt";
 export * from "./storeGoals/";
+export * from "./IStoreItemSummary";

package/lib/domain/utility/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./utils";
 export * from "./orderUtils";
+export * from "./itemImageUtils";

package/lib/domain/utility/index.js

@@ -5,4 +5,5 @@ function __export(m) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __export(require("./utils"));
 __export(require("./orderUtils"));
+__export(require("./itemImageUtils"));
 //# sourceMappingURL=index.js.map

package/lib/domain/utility/itemImageUtils.d.ts

@@ -0,0 +1,3 @@
+import { IItem } from "@aptos-scp/scp-component-store-items";
+import { IConfigurationManager } from "@aptos-scp/scp-component-store-selling-core";
+export declare function getImageUrlForItem(configurationManager: IConfigurationManager, item: IItem): string;

package/lib/domain/utility/itemImageUtils.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const scp_component_store_items_1 = require("@aptos-scp/scp-component-store-items");
+function getImageUrlForItem(configurationManager, item) {
+    var _a, _b;
+    const lineItemImageConfig = configurationManager.getFunctionalBehaviorValues().lineItemImage;
+    switch (lineItemImageConfig.imageSource) {
+        case "ImageFromItemData":
+            if ((_a = item.images) === null || _a === void 0 ? void 0 : _a.length) {
+                const primaryImages = item.images.filter((x) => x.primaryImage);
+                return (primaryImages.length > 0 ? primaryImages : item.images)[0].imageUrl;
+            }
+            return undefined;
+        case "ImageFromUrlPattern":
+            const urlPattern = lineItemImageConfig.urlPattern;
+            const aSkuKey = (_b = item.lookupKeys) === null || _b === void 0 ? void 0 : _b.find((aKey) => aKey.keyType === scp_component_store_items_1.KeyType.SKU);
+            if (aSkuKey) {
+                return urlPattern.replace(/{{SKU}}/g, aSkuKey.value);
+            }
+            return urlPattern;
+        default:
+            return undefined;
+    }
+}
+exports.getImageUrlForItem = getImageUrlForItem;
+//# sourceMappingURL=itemImageUtils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-scp/scp-component-store-selling-features-domain-model",
-  "version": "1.28.0",
+  "version": "1.30.0",
   "description": "This component library provides the common components to handle the coordination of processing the business events from the UI.",
   "private": false,
   "license": "SEE LICENSE IN LICENSE.md",
@@ -83,7 +83,7 @@
     "@aptos-scp/scp-component-taxation": "^5.27.3",
     "@aptos-scp/scp-component-user": "^1.4.0",
     "@aptos-scp/scp-types-client-registration": "^1.4.0",
-    "@aptos-scp/scp-types-commerce-devices": "^3.4.0",
+    "@aptos-scp/scp-types-commerce-devices": "^3.6.0",
     "@aptos-scp/scp-types-commerce-transaction": "^1.63.0",
     "@aptos-scp/scp-types-core": "^1.0.5",
     "@aptos-scp/scp-types-core-config": "^2.2.1",