@adobe/acc-js-sdk 1.1.28 → 1.1.30

package/docs/changeLog.html

@@ -3,6 +3,21 @@ layout: page
 title: Change Log
 ---
 
+<section class="changelog"><h1>Version 1.1.30</h1>
+  <h2>2023/06/19</h2>
+  <li>
+    Fixed an issue causing errors when parsing some specific enumerations such as xtk:dataTransfer:decimalCount which
+    contain enumeration values without "value" attributes and whose "name" attribute contains stringified numbers.
+  </li>
+</section>
+
+<section class="changelog"><h1>Version 1.1.29</h1>
+  <h2>2023/06/15</h2>
+  <li>
+    Passing pushdown options to observability layer
+  </li>
+</section>
+
 <section class="changelog"><h1>Version 1.1.28</h1>
   <h2>2023/06/09</h2>
   <li>

package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.28",
+  "version": "1.1.30",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@adobe/acc-js-sdk",
-      "version": "1.1.28",
+      "version": "1.1.30",
       "license": "ISC",
       "dependencies": {
         "axios": "^1.2.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.28",
+  "version": "1.1.30",
   "description": "ACC Javascript SDK",
   "main": "src/index.js",
   "homepage": "https://github.com/adobe/acc-js-sdk#readme",

package/src/application.js

@@ -1021,7 +1021,12 @@ function XtkEnumerationValue(xml, baseType, parentTranslationId) {
      * @type {string}
      */
     this.applicableIf = EntityAccessor.getAttributeAsString(xml, "applicableIf");
-    const stringValue = EntityAccessor.getAttributeAsString(xml, "value");
+    let stringValue = EntityAccessor.getAttributeAsString(xml, "value");
+    if (stringValue == "" && XtkCaster.isNumericType(baseType)) {
+        // Some enumerations (ex: xtk:dataTransfer:decimalCount) are of numeric type but do
+        // not have a "value" defined. In this case, we try to cas the name as the value
+        stringValue = this.name;
+    }
     /**
      * The enumeration value, casted according to the enumeration type
      * @type {*}
@@ -1082,31 +1087,46 @@ class XtkEnumeration {
          * The enumerations values 
          * @type {Utils.ArrayMap<Campaign.XtkEnumerationValue>}
          */
-         this.values = new ArrayMap();
-
-         var defaultValue = EntityAccessor.getAttributeAsString(xml, "default");
-         this._localizationId = `${schemaId}__${this.name}`.replace(':','__');
+        this.values = new ArrayMap();
+
+        var defaultValue = EntityAccessor.getAttributeAsString(xml, "default");
+        this._localizationId = `${schemaId}__${this.name}`.replace(':','__');
+
+         // Determine if the enumeration can support both access by name and by index.
+         // Some enumerations, such as xtk:dataTransfer:decimalCount are ambiguous since
+         // they have names which are string reprensentation of their values (ex: name="0").
+         // In this case enumValue[0] may mean either the first enumeration value (index 0)
+         // or the enumeration value with value "0" which happens to be the second
+        let supportsIndexing = true;
+        const values = [];
+        for (var child of EntityAccessor.getChildElements(xml, "value")) {
+            const e = new XtkEnumerationValue(child, this.baseType, this._localizationId);
+            values.push(e);
+            const numericName = +e.name;
+            if (numericName === numericName) {
+                // Name is a number
+                supportsIndexing = false;
+            }
+        }
 
-         for (var child of EntityAccessor.getChildElements(xml, "value")) {
-             const e = new XtkEnumerationValue(child, this.baseType, this._localizationId);
-             this.values._push(e.name, e);
-             if (e.image != "") this.hasImage = true;
-             const stringValue = EntityAccessor.getAttributeAsString(child, "name");
-             if (defaultValue == stringValue)
-                 this.default = e;
-         }
+        for (const e of values) {
+            this.values._push(e.name, e, !supportsIndexing);
+            if (e.image != "") this.hasImage = true;
+            const stringValue = e.name;
+            if (defaultValue == stringValue)
+                this.default = e;
+        }
 
-         this.labelLocalizationId = this._localizationId + "__@label";
-         this.descriptionLocalizationId = this._localizationId + "__@desc";
-         propagateImplicitValues(this, true);
+        this.labelLocalizationId = this._localizationId + "__@label";
+        this.descriptionLocalizationId = this._localizationId + "__@desc";
+        propagateImplicitValues(this, true);
 
         /**
          * The system enumeration name, without the schema id prefix
          * @type {string}
          */
-         this.shortName = this.name;
-         this.name = `${schemaId}:${this.shortName}`;
-         
+        this.shortName = this.name;
+        this.name = `${schemaId}:${this.shortName}`;
     }
 }
 

package/src/client.js

@@ -911,7 +911,7 @@ class Client {
         this._observers.map((observer) => callback(observer));
     }
 
-    _trackEvent(eventName, parentEvent, payload) {
+    _trackEvent(eventName, parentEvent, payload, pushDownOptions) {
         try {
             if (payload && payload.name === 'CampaignException') {
                 payload = {
@@ -933,6 +933,9 @@ class Client {
                 payload: payload,
                 timestamp: now,
             };
+            if (pushDownOptions) {
+                event.pushDownOptions = pushDownOptions;
+            }
             if (parentEvent) event.parentEventId = parentEvent.eventId;
             this._notifyObservers((observer) => observer.event && observer.event(event, parentEvent));
 
@@ -1046,6 +1049,7 @@ class Client {
         if (this._traceAPICalls) {
             console.log(`RETRY SOAP//request ${safeCallData}`);
         }
+        const pushDownOptions = soapCall._pushDownOptions;
         const event = this._trackEvent('SOAP//request', undefined, {
             urn: soapCall.urn,
             methodName: soapCall.methodName,
@@ -1053,16 +1057,16 @@ class Client {
             retry: true,
             retryCount: soapCall._retryCount,
             safeCallData: safeCallData,
-        });
+        }, pushDownOptions);
         try {
             await soapCall.execute();
             const safeCallResponse = Util.trim(soapCall.response);
             if (this._traceAPICalls) {
                 console.log(`SOAP//response ${safeCallResponse}`);
             }
-            this._trackEvent('SOAP//response', event, { safeCallResponse: safeCallResponse });
+            this._trackEvent('SOAP//response', event, { safeCallResponse: safeCallResponse }, pushDownOptions);
         } catch(error) {
-            this._trackEvent('SOAP//failure', event, error);
+            this._trackEvent('SOAP//failure', event, error, pushDownOptions);
             throw error;
         }
         return;
@@ -1314,6 +1318,7 @@ class Client {
             console.log(`SOAP//request ${safeCallData}`);
         that._notifyObservers((observer) => observer.onSOAPCall && observer.onSOAPCall(soapCall, safeCallData) );
 
+        const pushDownOptions = soapCall._pushDownOptions;
         const event = this._trackEvent('SOAP//request', undefined, {
             urn: soapCall.urn,
             methodName: soapCall.methodName,
@@ -1321,21 +1326,21 @@ class Client {
             retry: false,
             retryCount: soapCall._retryCount,
             safeCallData: safeCallData,
-        });
+        }, pushDownOptions);
         return soapCall.execute()
             .then(() => {
                 const safeCallResponse = Util.trim(soapCall.response);
                 if (that._traceAPICalls)
                     console.log(`SOAP//response ${safeCallResponse}`);
                 that._notifyObservers((observer) => observer.onSOAPCallSuccess && observer.onSOAPCallSuccess(soapCall, safeCallResponse) );
-                this._trackEvent('SOAP//response', event, { safeCallResponse: safeCallResponse });
+                this._trackEvent('SOAP//response', event, { safeCallResponse: safeCallResponse }, pushDownOptions);
                 return Promise.resolve();
             })
             .catch((ex) => {
                 if (that._traceAPICalls)
                     console.log(`SOAP//failure ${ex.toString()}`);
                 that._notifyObservers((observer) => observer.onSOAPCallFailure && observer.onSOAPCallFailure(soapCall, ex) );
-                this._trackEvent('SOAP//failure', event, ex);
+                this._trackEvent('SOAP//failure', event, ex, pushDownOptions);
                 // Call session expiration callback in case of 401
                 if (ex.statusCode == 401 && that._refreshClient && soapCall.retry) {
                     return this._retrySoapCall(soapCall);
@@ -1680,7 +1685,7 @@ class Client {
      * @private
      * @deprecated since version 1.0.0
      */
-     async _getSecretKeyCipher() {
+    async _getSecretKeyCipher() {
         var that = this;
         if (this._secretKeyCipher) return this._secretKeyCipher;
         return that.getOption("XtkSecretKey").then(function(secretKey) {
@@ -1701,7 +1706,7 @@ class Client {
      * @param {boolean} internal indicates an "internal" call, i.e. a call performed by the SDK itself rather than the user of the SDK. For instance, the SDK will dynamically load schemas to find method definitions
      * @return {XML.XtkObject} A DOM or JSON representation of the entity, or null if the entity is not found
      */
-     async getEntityIfMoreRecent(entityType, fullName, representation, internal) {
+    async getEntityIfMoreRecent(entityType, fullName, representation, internal) {
         const soapCall = this._prepareSoapCall("xtk:persist", "GetEntityIfMoreRecent", true, internal, this._connectionParameters._options.extraHttpHeaders);
         const inputParams = [
             { name: "pk", type: "string", value: entityType + "|" + fullName },
@@ -2080,7 +2085,7 @@ class Client {
             const result = this._toRepresentation(xml, representation);
             return result;
         } catch(ex) {
-             throw CampaignException.REPORT_FETCH_FAILED(callContext.reportName, ex);
+            throw CampaignException.REPORT_FETCH_FAILED(callContext.reportName, ex);
         }
     }
 

package/src/util.js

@@ -194,14 +194,15 @@ class ArrayMap {
       });
   }
 
-  _push(key, value) {
+  _push(key, value, withoutIndexing) {
       let isNumKey = false;
       if (key) {
         // reserved keyworkds
         const isReserved = key === "_items" || key === "length" || key === "_push" || key === "forEach" || key === "map" || key === "_map" || key === "get" || key === "find" || key === "flatMap" || key === "filter";
 
         // already a child with the name => there's a problem with the schema
-        if (!isReserved && this[key]) throw new Error(`Failed to add element '${key}' to ArrayMap. There's already an item with the same name`);
+        if (!isReserved && this[key]) 
+          throw new Error(`Failed to add element '${key}' to ArrayMap. There's already an item with the same name`);
 
         // Set key as a enumerable property, so that elements can be accessed by key, 
         // but also iterated on with a for ... in loop
@@ -218,7 +219,7 @@ class ArrayMap {
         }
       }
 
-      if (!isNumKey) {
+      if (!withoutIndexing && !isNumKey) {
         // Set the index property so that items can be accessed by array index.
         // However, make it non-enumerable to make sure indexes do not show up in a for .. in loop
         Object.defineProperty(this, this._items.length, {

package/test/application.test.js

@@ -700,6 +700,43 @@ describe('Application', () => {
                     expect(enumeration).toBeFalsy();
                 });
             });
+
+            it("Should support numeric enumeration with implicit value", async () => {
+                // Example in xtk:dataTransfer:decimalCount
+                const client = await Mock.makeClient();
+                client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+                await client.NLWS.xtkSession.logon();
+                client._transport.mockReturnValueOnce(Promise.resolve(`<?xml version='1.0'?>
+                <SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='urn:wpp:default' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
+                <SOAP-ENV:Body>
+                    <GetEntityIfMoreRecentResponse xmlns='urn:wpp:default' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
+                        <pdomDoc xsi:type='ns:Element' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
+                            <schema name="dataTransfer" namespace="xtk" xtkschema="xtk:schema">
+                                <enumeration name="decimalCount" basetype="short">
+                                    <value value="-1" name="all" label="All"/>
+                                    <value name="0"/>
+                                    <value name="1"/>
+                                    <value name="2"/>
+                                    <value name="3"/>
+                                    <value name="4"/>
+                                    <value name="5"/>
+                                    <value name="6"/>
+                                    <value name="7"/>
+                                    <value name="8"/>
+                                    <value name="9"/>
+                                </enumeration>
+                            </schema>
+                        </pdomDoc>
+                    </GetEntityIfMoreRecentResponse>
+                </SOAP-ENV:Body>
+                </SOAP-ENV:Envelope>`));
+                const enumeration = await client.application.getSysEnum("decimalCount", "xtk:dataTransfer");
+                expect(enumeration.label).toBe("DecimalCount");
+                const values = enumeration.values;
+                expect(values["all"].value).toBe(-1)
+                expect(values["0"].value).toBe(0)
+                expect(values["1"].value).toBe(1)
+            });
         });
 
         describe("Keys", () => {