@adobe/acc-js-sdk 1.1.7 → 1.1.8

package/CHANGELOG.md

@@ -5,13 +5,17 @@ This is a node.js SDK for Campaign API. It exposes the Campaign API exactly like
 
 # Changelog 
 
+## Version 1.1.8
+_2022_10_03_
+
+* Added translation ids (`labelLocalizationId`,`descriptionLocalizationId`, `labelSingularLocalizationId`) for `XtkSchema`, `XtkSchemaNode`, `XtkEnumerationValue` and `XtkEnumeration`
+
 ## Version 1.1.7
 _2022_08_30_
 
 * New listener interface to be notified of internal events from the SDK. Can be used to integrate with observability frameworks. See the "Observers" section of the README file.
 * Experimental file upload feature. Will require server-side changes to work, and is currently limited to be used with browsers only.
 
-
 ## Version 1.1.6
 _2022_08_19_
 

package/README.md

@@ -1753,7 +1753,9 @@ const root = await node.linkTarget();
 | **namespace** | The namespace of the schema. For instance "nms"
 | **name** | The name of the schema (internal name)
 | **label** | The label (i.e. human readable, localised) name of the node.
+| **labelLocalizationId** | The translation id of the label of the node.
 | **labelSingular** | The singular label (i.e. human readable, localised) name of the schema. The label of a schema is typically a plural.
+| **labelSingularTranslationId** | The translation id of the label of the node of the singular label.
 | **isLibrary** | For schemas, indicates if the schema is a library
 | **mappingType** |Schema mapping type. Usually "sql"
 | **md5** | The MD5 code of the schema in the form of a hexadecimal string
@@ -1771,6 +1773,7 @@ A schema is also a `XtkSchemaNode` and the corresponding properties/methods are
 | **children** | A array/map of children of the node. See note on the ArrayMap structure below
 | **dataPolicy** | Returns a string of characters which provides the data policy of the current node.
 | **description** | A long, human readable, description of the node
+| **descriptionLocalizationId** | The translation id of the description of the node.
 | **editType** |Returns a string of characters which specifies the editing type of the current node.
 | **enum** | The name of the enumeration for the node, or an empty string if the node does node have an enumeration. See `enumeration()` method to get the corresponding `XtkSchemaNode`
 | **enumerationImage** | Returns the name of the image of the current node in the form of a string of characters.
@@ -1810,6 +1813,7 @@ A schema is also a `XtkSchemaNode` and the corresponding properties/methods are
 | **unbound** | Returns a boolean which indicates whether the current node has an unlimited number of children of the same type.
 | **joins** | Element of type "link" has an array of XtkJoin. See `joinNodes` method.
 | **label** | The label (i.e. human readable, localised) name of the node.
+| **labelLocalizationId** | The translation id of the label of the node.
 | **name** | The name of the node (internal name)
 | **nodePath**  | The xpath of the node
 | **parent** | The parent node (a `XtkSchemaNode` object). Will be null for schema nodes
@@ -1862,7 +1866,9 @@ A schema is also a `XtkSchemaNode` and the corresponding properties/methods are
 |---|---|
 | **name** |  The name of the enumeration, fully qualified, i.e. prefixed with the schema id
 | **label** | The label (i.e. human readable, localised) name of the key
+| **labelLocalizationId** | The translation id of the label of the key.
 | **description** | A long, human readable, description of the key
+| **descriptionLocalizationId** | The translation id of the description of the key.
 | **baseType** | The base type of the enumeration, usually "string" or "byte"
 | **default** | The default value of the enumeration, casted to the enumeration type
 | **hasImage** | If the enumeration has an image
@@ -1874,7 +1880,9 @@ A schema is also a `XtkSchemaNode` and the corresponding properties/methods are
 |---|---|
 | **name** |  The name of the key (internal name)
 | **label** | The label (i.e. human readable, localised) name of the key
+| **labelLocalizationId** | The translation id of the label of the key.
 | **description** | A long, human readable, description of the key
+| **descriptionLocalizationId** | The translation id of the description of the key.
 | **image** |
 | **enabledIf** |
 | **applicableIf** |

package/package-lock.json

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

package/package.json

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

package/src/application.js

@@ -422,6 +422,8 @@ class XtkSchemaNode {
          */
         this.nodePath = this._getNodePath(true)._path;
 
+        this._buildLocalizationIds();
+
         /**
          * Element of type "link" has an array of XtkJoin
          * @type {XtkJoin[]}
@@ -634,6 +636,35 @@ class XtkSchemaNode {
         propagateImplicitValues(this);
     }
 
+    /* create two ids that are identifying in an unique way the node label and 
+     * the node description 
+     * examples:
+     * nms__recipient__e____recipient__emailFormat__@desc
+     * nms__recipient__e____recipient__mobilePhone__@label 
+     * */
+    _buildLocalizationIds() {
+        if (!this.parent) {
+          this._localizationId = this.schema.id.replace(":", "__");
+        } else {
+          this._localizationId = this.parent._localizationId;
+        }
+
+        if (this.parent) {
+          // Separate each element of the path with a double _
+          if (this.isAttribute) {
+            this._localizationId = this._localizationId + "__" + this.name.replace('@', '');
+          } else {
+            // node is not an attribute so it is an element add "e____"
+            this._localizationId = this._localizationId + "__e____" + this.name;
+          }
+        }
+        this.labelLocalizationId = this._localizationId + "__@label";
+        this.descriptionLocalizationId = this._localizationId + "__@desc";
+        if (!this.parent) {
+            this.labelSingularLocalizationId = this._localizationId + "__@labelSingular";
+        }
+    }
+
     /**
      * Indicates whether the current node has an unlimited number of children of the same type.
      *
@@ -901,9 +932,10 @@ class XtkSchemaNode {
  * @constructor
  * @param {XML.XtkObject} The enumeration value definition
  * @param {Campaign.XtkEnumerationType} baseType the enumeration type (often "string" or "byte")
+ * @param {string} parentTranslationId the translation id of the parent node
  * @memberof Campaign
  */
-function XtkEnumerationValue(xml, baseType) {
+function XtkEnumerationValue(xml, baseType, parentTranslationId) {
     /**
      * The value (unique) name
      * @type {string}
@@ -914,6 +946,14 @@ function XtkEnumerationValue(xml, baseType) {
      * @type {string}
      */
     this.label = EntityAccessor.getAttributeAsString(xml, "label");
+    /**
+     * Unique identifier for the translation of the label
+     * */
+    this.labelLocalizationId = parentTranslationId + '__' + this.name + '__@label';
+    /**
+     * Unique identifier for the tran,slation of the description of the label
+     * */
+    this.descriptionLocalizationId = parentTranslationId + '__' + this.name + '__@desc';
     /**
      * A human friendly long description of the value
      * @type {string}
@@ -997,25 +1037,29 @@ class XtkEnumeration {
          */
          this.values = new ArrayMap();
 
-        var defaultValue = EntityAccessor.getAttributeAsString(xml, "default");
+         var defaultValue = EntityAccessor.getAttributeAsString(xml, "default");
+         this._localizationId = `${schemaId}__${this.name}`.replace(':','__');
 
-        for (var child of EntityAccessor.getChildElements(xml, "value")) {
-            const e = new XtkEnumerationValue(child, this.baseType);
-            this.values._push(e.name, e);
-            if (e.image != "") this.hasImage = true;
-            const stringValue = EntityAccessor.getAttributeAsString(child, "value");
-            if (defaultValue == stringValue)
-                this.default = e;
-        }
+         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, "value");
+             if (defaultValue == stringValue)
+                 this.default = e;
+         }
 
-        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.name = `${schemaId}:${this.shortName}`;
+         
     }
 }
 
@@ -1063,7 +1107,6 @@ class XtkSchema extends XtkSchemaNode {
          * @type {string}
          */
         this.labelSingular = EntityAccessor.getAttributeAsString(xml, "labelSingular");
-
         /**
          * The schema mappgin type, following the xtk:srcSchema:mappingType enumeration
          * @type {Campaign.XtkSchemaMappingType}

package/test/application.test.js

@@ -2021,6 +2021,77 @@ describe('Application', () => {
                 expect(schema.userDescription).toBe("recipient");
             });
         });
+
+        describe("Translation ids", () => {
+          it("schema should have a correct label localization id", () => {
+            const xml = DomUtil.parse("<schema namespace='nms' name='recipient'><element name='recipient' label='Recipients'/></schema>");
+            const schema = newSchema(xml);
+            expect(schema.labelLocalizationId).toBe('nms__recipient__@label');
+            expect(schema.descriptionLocalizationId).toBe('nms__recipient__@desc');
+          });
+
+          it("schema should have a correct singular label localization id", () => {
+            const xml = DomUtil.parse("<schema namespace='nms' name='recipient'><element name='recipient' label='Recipients'/></schema>");
+            const schema = newSchema(xml);
+            expect(schema.labelSingularLocalizationId).toBe('nms__recipient__@labelSingular');
+          });
+
+          it("root node should have a correct label localization id", () => {
+            const xml = DomUtil.parse("<schema namespace='nms' name='recipient'><element name='recipient' label='Recipients'/></schema>");
+            const schema = newSchema(xml);
+            const root = schema.root;
+            expect(root.labelLocalizationId).toBe('nms__recipient__e____recipient__@label');
+            expect(root.descriptionLocalizationId).toBe('nms__recipient__e____recipient__@desc');
+          });
+
+          it("child node should have a correct label localization id", () => {
+            const xml = DomUtil.parse("<schema namespace='nms' name='recipient'><element name='lib' label='library'/><element name='recipient' label='Recipients'/></schema>");
+            const schema = newSchema(xml);
+            const lib = schema.children["lib"];
+            expect(lib.labelLocalizationId).toBe('nms__recipient__e____lib__@label');
+            expect(lib.descriptionLocalizationId).toBe('nms__recipient__e____lib__@desc');
+          });
+
+          it("attribute should have a correct label localization id", () => {
+            const xml = DomUtil.parse(`<schema namespace='nms' name='recipient'>
+                                            <element name='recipient' label='Recipients'>
+                                                <attribute name='email' type='string' label='email' length='3'/>
+                                            </element>
+                                        </schema>`);
+            const schema = newSchema(xml);
+            const root = schema.root;
+            expect(root.children.get("@email").labelLocalizationId).toBe('nms__recipient__e____recipient__email__@label');
+            expect(root.children.get("@email").descriptionLocalizationId).toBe('nms__recipient__e____recipient__email__@desc');
+          });
+
+          it("Enumeration should have a correct label localization id", () => {
+            const xml = DomUtil.parse(`<schema namespace='nms' name='recipient'>
+                                            <enumeration name="gender" basetype="byte"/>
+                                            <element name='recipient' label='Recipients'></element>
+                                        </schema>`);
+            const schema = newSchema(xml);
+            const enumerations = schema.enumerations;
+            expect(enumerations.gender.labelLocalizationId).toBe('nms__recipient__gender__@label');
+            expect(enumerations.gender.descriptionLocalizationId).toBe('nms__recipient__gender__@desc');
+          });
+
+          it("Enumeration value should have a correct label localization id", () => {
+            const xml = DomUtil.parse(`<schema namespace='nms' name='recipient'>
+                                            <enumeration name="gender" basetype="byte">
+                                                <value name="male" value="0"/>
+                                                <value name="female" value="1"/>                                    
+                                            </enumeration>
+                                            <element name='recipient' label='Recipients'>
+                                            <attribute advanced="true" desc="Recipient sex" enum="nms:recipient:gender"
+                                                label="Gender" name="gender" sqlname="iGender" type="byte"/>
+                                            </element>
+                                        </schema>`);
+            const schema = newSchema(xml);
+            const enumerations = schema.enumerations;
+            expect(enumerations.gender.values.male.labelLocalizationId).toBe('nms__recipient__gender__male__@label');
+            expect(enumerations.gender.values.male.descriptionLocalizationId).toBe('nms__recipient__gender__male__@desc');
+          })
+        });
     });
 
     describe("CurrentLogin", () => {