@adobe/acc-js-sdk 1.1.56 → 1.1.57

package/docs/changeLog.html

@@ -2,7 +2,21 @@
 layout: page
 title: Change Log
 ---
-<section class="changelog"><h1>Version 1.1.55</h1>
+<section class="changelog"><h1>Version 1.1.57</h1>
+  <h2>2025/06/24</h2>
+  <li>
+    Bumped dependencies version to fix vulnerabilities
+  </li>
+  <li>
+    Update getSchema function to support XDM schemas (without caching)
+  </li>
+  <li>
+    New "instanceKey" connection parameter can be used to configure the cache key
+  </li>
+</section>
+
+
+<section class="changelog"><h1>Version 1.1.56</h1>
   <h2>2025/01/27</h2>
   <li>
     Bumped dependencies version to fix vulnerabilities

package/docs/connectionParameters.html

@@ -104,6 +104,16 @@ const connectionParameters = sdk.ConnectionParameters.ofUserAndPassword(
             <td>number</td>
             <td>Can be used to set the APIs call timeout (in ms)</td>
         </tr>
+        <tr>
+            <td>cacheRootKey</td>
+            <td>"default" or "none"</td>
+            <td>Determine the prefix to use for the keys in the caches of schemas, options, etc.<p>The value "default" means that cached keys are prefixed with "acc.js.sdk.${this.sdk.getSDKVersion().version}.${instanceKey}.cache."</p></td>
+        </tr>
+        <tr>
+            <td>instanceKey</td>
+            <td>string</td>
+            <td>An optional value to override the instance key which is used for the caches of schemas, options, etc.</td>
+        </tr>
     </tbody>
 </table>
 

package/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@adobe/acc-js-sdk",
-  "version": "1.1.56",
+  "version": "1.1.57",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@adobe/acc-js-sdk",
-      "version": "1.1.56",
+      "version": "1.1.57",
       "license": "ISC",
       "dependencies": {
         "axios": "^1.7.8",
@@ -1275,9 +1275,10 @@
       "license": "MIT"
     },
     "node_modules/brace-expansion": {
-      "version": "1.1.11",
+      "version": "1.1.12",
+      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz",
+      "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==",
       "dev": true,
-      "license": "MIT",
       "dependencies": {
         "balanced-match": "^1.0.0",
         "concat-map": "0.0.1"
@@ -5403,7 +5404,9 @@
       "dev": true
     },
     "brace-expansion": {
-      "version": "1.1.11",
+      "version": "1.1.12",
+      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz",
+      "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==",
       "dev": true,
       "requires": {
         "balanced-match": "^1.0.0",

package/package.json

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

package/src/client.js

@@ -308,6 +308,7 @@ class Credentials {
     * @property {boolean} noMethodInURL - Can be set to true to remove the method name from the URL
     * @property {number} timeout - Can be set to change the HTTP call timeout. Value is passed in ms.
     * @property {string} cacheRootKey - "default" or "none" - determine the prefix to use for the keys in the caches of schemas, options, etc.
+    * @property {string} instanceKey - an optional value to override the instance key which is used for the caches of schemas, options, etc.
     * @memberOf Campaign
  */
 
@@ -829,8 +830,10 @@ class Client {
         this._secretKeyCipher = undefined;
 
         this._storage = connectionParameters._options._storage;
-        // TODO late cache initiallzation because need XtkDatabaseId / instance name
-        var instanceKey = connectionParameters._endpoint || "";
+
+        var instanceKey = connectionParameters._options.instanceKey;
+        if (!instanceKey)
+            instanceKey = connectionParameters._endpoint || "";
         if (instanceKey.startsWith("http://")) instanceKey = instanceKey.substr(7);
         if (instanceKey.startsWith("https://")) instanceKey = instanceKey.substr(8);
 
@@ -894,6 +897,7 @@ class Client {
                 endpoint: this._connectionParameters._endpoint,
                 createdAt: Date.now(),
                 clientApp: this._connectionParameters._options.clientApp,
+                instanceKey: instanceKey
             }
         };
         if  (this._connectionParameters._credentials) {
@@ -1928,6 +1932,14 @@ class Client {
      * @returns {XML.XtkObject}  the schema definition, as either a DOM document or a JSON object
      */
     async getSchema(schemaId, representation, internal) {
+        // Support for Orchestrated Campaign XDM schemas (do not use cache)
+        const pipeIndex = schemaId.indexOf("|");
+        if( pipeIndex != -1 && schemaId.startsWith("xdm:") ) {
+            const entityType = schemaId.substring(0, pipeIndex);
+            schemaId = schemaId.substring(pipeIndex + 1);
+            const entity = await this.getEntityIfMoreRecent(entityType, schemaId, representation, internal);
+            return entity;
+        }
         var entity = await this._entityCache.get("xtk:schema", schemaId);
         if (!entity) {
               // special case of "temp:group:*" schemas for nms:group

package/test/client.test.js

@@ -435,6 +435,20 @@ describe('ACC Client', function () {
             await client.NLWS.xtkSession.logoff();
         });
 
+        it("Should return XDM schema definition", async () => {
+            const client = await Mock.makeClient();
+            client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
+            await client.NLWS.xtkSession.logon();
+
+            client._transport.mockReturnValueOnce(Mock.GET_UNION_PROFILE_SCHEMA_RESPONSE);
+            var schema = await client.getSchema("xdm:tenant:unions|_xdm.context.profile__union");
+            expect(schema["namespace"]).toBe("xdm");
+            expect(schema["name"]).toBe("profile__union");
+
+            client._transport.mockReturnValueOnce(Mock.LOGOFF_RESPONSE);
+            await client.NLWS.xtkSession.logoff();
+        });
+
         it("Should return temp group schema definition", async () => {
             const client = await Mock.makeClient();
             client._transport.mockReturnValueOnce(Mock.LOGON_RESPONSE);
@@ -2741,6 +2755,15 @@ describe('ACC Client', function () {
             expect(client._optionCache._storage._rootKey).toBe(`OptionCache$`);
         });
 
+        it("Should support instanceKey", async () => {
+            // Default has version & instance name
+            const version = sdk.getSDKVersion().version; // "${version}" or similar
+            connectionParameters = sdk.ConnectionParameters.ofUserAndPassword("http://acc-sdk:8080", "admin", "admin");
+            connectionParameters = sdk.ConnectionParameters.ofUserAndPassword("http://acc-sdk:8080", "admin", "admin", { instanceKey: "hello" });
+            var client = await sdk.init(connectionParameters);
+            expect(client._optionCache._storage._rootKey).toBe(`acc.js.sdk.${version}.hello.cache.OptionCache$`);
+        });
+
         describe("Should simulate the Shell Cache API", () => {
             // See https://github.com/AdobeDocs/exc-app/blob/master/docs/modules/cache.md#sample-code
             it("Sould get cached option", async () => {

package/test/mock.js

@@ -455,6 +455,28 @@ const GET_XTK_QUERY_SCHEMA_RESPONSE = Promise.resolve(`<?xml version='1.0'?>
     </SOAP-ENV:Body>
     </SOAP-ENV:Envelope>`);
 
+const GET_UNION_PROFILE_SCHEMA_RESPONSE = 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 label="XDM Individual Profile" labelSingular="XDM Individual Profile" library="true" name="profile__union" namespace="xdm" xtkschema="xtk:schema">
+                <element autopk="false" label="XDM Individual Profile" name="profile__union" pkgStatus="never">
+                    <element name="_ajobatchjourneystage" type="">
+                    <attribute label="email" length="255" name="email" type="string"/>
+                    <attribute label="Loyalty Member" name="loyaltyMember" type="boolean"/>
+                    <attribute label="Use Case ID" length="255" name="useCaseInstanceId" type="string"/>
+                    </element>
+                    <attribute label="Identifier" length="255" name="_id" type="string"/>
+                </element>
+                </schema>
+
+            </pdomDoc>
+        </GetEntityIfMoreRecentResponse>
+    </SOAP-ENV:Body>
+    </SOAP-ENV:Envelope>`);
+
 const GET_NMS_DELIVERY_SCHEMA_RESPONSE = 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>
@@ -1127,6 +1149,7 @@ exports.Mock = {
   GET_OPTION_NOTFOUND_RESPONSE: GET_OPTION_NOTFOUND_RESPONSE,
   GET_OPTION_MISSING_DATA_RESPONSE: GET_OPTION_MISSING_DATA_RESPONSE,
   GET_XTK_QUERY_SCHEMA_RESPONSE: GET_XTK_QUERY_SCHEMA_RESPONSE,
+  GET_UNION_PROFILE_SCHEMA_RESPONSE: GET_UNION_PROFILE_SCHEMA_RESPONSE,
   GET_NMS_DELIVERY_SCHEMA_RESPONSE: GET_NMS_DELIVERY_SCHEMA_RESPONSE,
   GET_DELIVERY_TEST_RESPONSE: GET_DELIVERY_TEST_RESPONSE,
   GET_MID_EXT_ACCOUNT_RESPONSE: GET_MID_EXT_ACCOUNT_RESPONSE,