@adobe/acc-js-sdk 1.1.10 → 1.1.11

package/docs/assets/css/styles.css

@@ -0,0 +1,362 @@
+---
+---
+* {
+  padding: 0;
+  margin: 0;
+  box-sizing: border-box;
+}
+
+html { 
+  font-family: Helvetica, Sans-Serif;
+  -ms-text-size-adjust: 100%;
+  -webkit-text-size-adjust: 100%;
+  font-weight: 300;
+  font-size: 18px;
+  line-height: 28px;
+}
+
+body {
+  display: flex;
+  flex-direction: column;
+}
+
+.notFound {
+  display: flex;
+  flex-direction: column;
+  margin: auto;
+  width: 800px;
+  max-width: 800px;  
+  margin-top: 80px;
+}
+
+
+.header {
+  display: flex;
+  flex-direction: row;
+  height: 52px;
+  min-height: 52px;
+  border-bottom: 1px solid #4f966a;
+  position: fixed;
+  top: 0px;
+  left: 0px;
+  width: 100%;
+  background-color: white;
+  cursor: pointer;
+}
+
+.logo {
+  display: flex;
+  margin-left: 16px;
+  margin-right: 0;
+  margin-top: 4px;
+  margin-bottom: 4px;
+  cursor: pointer;
+}
+
+.header h1 {
+  display: flex;
+  line-height: 44px;
+  margin-left: 16px;
+  font-size: 36px;
+  font-weight: 300;
+  border: none;
+  margin-top: 0 !important  ;
+}
+
+.footer {
+  width: 100%;
+  margin-bottom: 16px;
+}
+
+.body {
+  display: flex;
+  flex-direction: column;
+  margin: auto;
+  width: 800px;
+  max-width: 800px;
+  margin-top: 16px;
+  margin-top: 72px;
+}
+
+nav {
+  display: flex;
+  flex-direction: column;
+  position: fixed;
+  top: 0px;
+  left: 0px;
+  margin-left: 16px;
+  height: 100%;
+  padding-top: 92px;
+  font-size: 16px;
+  line-height: 20px;
+}
+
+nav a, nav a:visited, nav a:active {
+  text-decoration: none;
+}
+
+nav ul {
+  overflow: scroll
+}
+
+nav li {
+  list-style: none;
+}
+
+nav li li {
+  margin-left: 8px;
+}
+
+a, a:visited, a:active {
+  color: #4f966a;
+  cursor: pointer;
+}
+a:hover {
+  text-decoration:underline;
+}
+
+h1 {
+  color: #4f966a;
+  font-size: 34px;
+  font-weight: 300;
+  padding-bottom: 4px;
+}
+
+h1:not(:first-child) {
+  margin-top: 42px;
+}
+
+h2 {
+  margin-top: 42px;
+  color: #4f966a;
+  font-size: 24px;
+  font-weight: 300;
+  padding-bottom: 0px;
+}
+
+p {
+  margin-top: 20px;
+  margin-bottom: 4px;
+}
+
+b {
+  font-weight: 400;
+}
+
+table {
+  border: 1px solid #4f966a;
+  border-collapse: collapse;
+}
+thead {
+  border-bottom: 1px solid #4f966a;
+}
+th {
+  color: #4f966a;
+  font-weight: 400;
+  text-align: left;
+  padding-left: 8px;
+  padding-right: 8px;
+  padding-top: 8px;
+  padding-bottom: 8px;
+}
+tr:nth-child(even){
+  background-color: #ecf6f0;
+}
+td {
+  padding-left: 8px;
+  padding-right: 8px;
+  padding-bottom: 8px;
+}
+
+.cta {
+  width: 200px;
+  min-width: 200px;
+  max-width: 200px;
+  margin-top: 36px;
+  margin-bottom: 36px;
+  margin-left: auto;
+  margin-right: auto;
+  height: 48px;
+  border: 1px solid #4f966a;
+  border-radius: 3px;
+  color: #4f966a;
+  background-color:  #ecf6f0;
+  cursor: pointer;
+  font-size: 24px;
+}
+.cta:hover {
+  background-color: white;
+}
+
+.card-row {
+  display: flex;
+  flex-direction: row;
+  margin-top: 36px;
+  margin-bottom: 36px;
+  margin-left: auto;
+  margin-right: auto;
+  gap: 36px;
+}
+
+.card {
+  display: flex;
+  flex-direction: column;
+  border: 1px solid #4f966a;
+  width: 340px;
+  max-width: 340px;
+  min-width: 340px;
+  min-height: 280px;
+}
+
+.card h1 {
+  text-align: center;
+  font-size: 24px;
+  margin-top: 8px;
+}
+
+.code {
+  color: #72d999;
+  font-family: Inconsolata, monospace;
+  font-weight: 300;
+  font-size: 14px;
+  line-height: 18px;
+  background-color: #383E42;
+  padding-top: 8px;
+  padding-bottom: 8px;
+  padding-left: 18px;
+  padding-right: 18px;
+  border-radius: 8px;
+  word-wrap: break-word;
+  overflow-wrap: break-word;;
+  white-space: pre-wrap;
+}
+section.changelog {
+  margin-top: 16px;
+  margin-bottom: 24px;
+}
+
+section.changelog h1 {
+  font-size: 24px;
+  font-weight: 300;
+  margin-top: 0;
+  margin-bottom: 0;
+}
+
+section.changelog h2 {
+  font-size: 14px;
+  font-weight: 300;
+  margin-top: 0;
+  margin-bottom: 12px;
+  color: #383E42;
+  font-style: italic;
+}
+
+.warning {
+  color: #D972B2;
+  border-left: 4px solid #D972B2;
+  padding-left: 10px;
+  margin-bottom: 18px;
+}
+
+.info {
+  border-left: 4px solid gray;
+  padding-left: 10px;
+  margin-bottom: 18px;
+}
+
+.license {
+  margin-left: auto;
+  margin-right: auto;
+  margin-top: 24px;
+  font-size: 12px;
+  line-height: 14px;;
+  white-space: pre;;
+}
+
+.marquee {
+  color: #4f966a;
+  font-size: 36px;
+  line-height: 56px;
+  margin-left: auto;
+  margin-right: auto;
+  margin-top: 40px;
+  margin-bottom: 12px;
+}
+
+.caption {
+  font-style: italic;
+  text-align: center;
+  margin-left: auto;
+  margin-right: auto;
+  margin-top: -2px;
+  color: #383E42;
+}
+
+span.emphasis {
+  color: white;
+}
+
+span.comment {
+  color: #4f966a;
+}
+
+p.ref {
+  margin-top: 2px;
+  margin-bottom: 2px;
+}
+
+p.ref:before {
+  content: url({{ site.baseurl }}/assets/images/ref.svg);
+  margin-right: 8px;
+}
+  
+.doc-example {
+  margin-left: 120px;
+  margin-top: 6px;
+  margin-bottom: 6px;
+}
+
+.doc-exampleh1, .doc-example h2 {
+  margin-top: 4px !important;
+  margin-bottom: 4px !important;
+}
+
+.blog {
+}
+
+.blog li {
+  list-style: none;
+}
+
+.blog-expert {
+}
+
+.blog-header {
+  font-size: 16px;
+  line-height: 16px;
+  font-style: italic;
+  color: #383E42;
+  margin-top: 2px;
+  margin-bottom: 4px;
+}
+
+.blog-expert h2 {
+  font-size: 18px;
+}
+.blog-expert h2 a {
+  text-decoration: none;
+}
+.blog-expert h2 a:hover, .blog-expert h2 a:active {
+  text-decoration: underline;
+}
+
+img {
+  margin: auto;
+  width: 400px;
+  max-width: 400px;
+}
+.logo img {
+  margin: 0;
+  width: 40px;
+  height: 40px;
+}

package/docs/assets/images/ref.svg

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generated by IcoMoon.io -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="16" height="16" viewBox="0 0 16 16">
+<path fill="#000000" d="M6.5 15h2.5c0.827 0 1.5-0.673 1.5-1.5 0-0.267-0.070-0.518-0.193-0.736 0.417-0.267 0.693-0.734 0.693-1.264 0-0.384-0.145-0.734-0.383-1 0.238-0.266 0.383-0.616 0.383-1 0-0.175-0.030-0.344-0.086-0.5h3.586c0.827 0 1.5-0.673 1.5-1.5s-0.673-1.5-1.5-1.5h-6.167l1.466-2.75c0.131-0.227 0.201-0.486 0.201-0.75 0-0.827-0.673-1.5-1.5-1.5-0.412 0-0.796 0.164-1.082 0.461-0.004 0.004-0.007 0.008-0.011 0.012l-3.407 3.737v-0.71c0-0.276-0.224-0.5-0.5-0.5h-3c-0.276 0-0.5 0.224-0.5 0.5v10c0 0.276 0.224 0.5 0.5 0.5h3c0.276 0 0.5-0.224 0.5-0.5v-0.691l2.276 1.138c0.069 0.035 0.146 0.053 0.224 0.053zM2.5 14c-0.276 0-0.5-0.224-0.5-0.5s0.224-0.5 0.5-0.5 0.5 0.224 0.5 0.5-0.224 0.5-0.5 0.5zM6.618 14l-2.618-1.309v-5.997l4.143-4.544c0.095-0.097 0.221-0.15 0.357-0.15 0.276 0 0.5 0.224 0.5 0.5 0 0.085-0.020 0.166-0.061 0.239-0.005 0.008-0.010 0.017-0.014 0.025l-1.866 3.5c-0.083 0.155-0.078 0.342 0.013 0.492s0.253 0.243 0.429 0.243h7c0.276 0 0.5 0.224 0.5 0.5s-0.224 0.5-0.5 0.5h-5c-0.276 0-0.5 0.224-0.5 0.5s0.224 0.5 0.5 0.5c0.276 0 0.5 0.224 0.5 0.5s-0.224 0.5-0.5 0.5c-0.276 0-0.5 0.224-0.5 0.5s0.224 0.5 0.5 0.5c0.276 0 0.5 0.224 0.5 0.5s-0.224 0.5-0.5 0.5h-0.5c-0.276 0-0.5 0.224-0.5 0.5s0.224 0.5 0.5 0.5c0.276 0 0.5 0.224 0.5 0.5s-0.224 0.5-0.5 0.5h-2.382z"></path>
+</svg>

package/docs/badgerFish.html

@@ -0,0 +1,14 @@
+---
+layout: page
+title: BadgerFish format
+---
+
+<p>
+  To distinguish between BadgerFish and SimpleJson format, all BadgerFish objects will have the BadgerFishObject class, that includes the top-level object, but also all children objects. A badgerfish object can be created as follows. It will automatically convert all the object literals into BadgerFishObjet class.
+</p>
+
+<p class="warning">BadgerFish representation is deprecated and only available for backwards compatibility reasons.</p>
+
+<pre class="code">
+const obj = new DomuUtil.BadgerFishObject({ "@att":"value });
+</pre>

package/docs/bestPractices.html

@@ -0,0 +1,189 @@
+---
+layout: page
+title: Best Practices
+---
+
+<h1>Start with the concepts</h1>
+
+<p></p>
+<p class="ref">Start with the <a href="{{ site.baseurl }}/concepts.html">concepts</a> behind Campaign and the SDK.</p>
+
+
+
+
+
+<h1>API limits</h1>
+
+<p>
+    Most of the Campaign APIs are not meant for high volume, low concurrency processing. For instance, we 
+    provide APIs to create recipients. However, this is not meant to be used as a streaming ingestion
+    API, i.e. you do not want to use this API to insert large amount of recipients. This kind of operation
+    should still be done in batch, using workflows.
+</p>
+
+<p>
+    However, the APIs are well fit to use for use cases such as an UI, Landing pages, within the provisioned
+    capacity.
+</p>
+
+
+
+
+<h1>XML or JSON</h1>
+
+<p>
+    The SDK supports both JSON and XML. Campaign internally uses XML, so it's always more accurate to use XML.
+    However it's not as simple to use XML as it is to use JSON. Still, the SDK provides several
+    <a href="{{ site.baseurl }}/domHelper.html">helpers</a> do deal with XML in a simple way.
+</p>
+
+<p>
+    You can use either one or both, however, it's a good idea to undestand the gotchas of using JSON. It
+    may seem easier than XML, but there are a few gotchas which makes this not an obvious choice. 
+</p>
+
+<p></p>
+<p class="ref">Learn about the <a href="{{ site.baseurl }}/xml2json.html">Gotchas of using JSON</a></p>
+<p class="ref">Understand the <a href="{{ site.baseurl }}/domHelper.html">DOM helpers</a> to make your life simpler with XML</p>
+
+
+
+<h1>Data types</h1>
+
+<p>
+    The SDK will not always return the proper data types. For instance, it may return a string instead of a 
+    number, an object in place of an array, etc.
+</p>
+
+<p>
+    Those are all consequences of using XML in the first place (attribute values are all serialized as strings)
+    but also of transforming XML to JSON and back.
+</p>
+
+<p>
+    Dealing with those inconsistencies in the application code can be challenging: it's difficult to always
+    keep them in mind and error-prone to rely on such rigor to make sure things are always correct.
+</p>
+
+<p>
+    Let's take as an example a <b>condition</b> object. This is usually used in queries to filter the
+    result, but is also available at many other places, such as sys filters, delivery targets, etc. The
+    <b>condition</b> object is defined in the xtk:queryDef schema from which there's an extract below.
+</p>
+
+<pre class="code">
+&lt;element name="condition">
+    &lt;attribute name="expr" type="string" label="Expression"/>
+    &lt;attribute name="ignore" <span class="emphasis">type="boolean"</span> label="Ignore condition"/>
+    ...
+    <span class="emphasis">
+    &lt;element ref="xtk:queryDef:condition" name="condition" ordered="true" unbound="true"/>
+    </span>
+    ...
+&lt;/element>
+</pre>
+
+<p>
+    In this example, we see two things: the ignore attribute is a boolean, and conditions are recursive objects
+    which can contain sub conditions. We also see that the <b>condition</b> node is a collection, i.e. that there
+    can be zero, one or more sub-conditions (unbound="true")
+</p>
+
+<pre class="code">
+&lt;condition>                               <span class="comment">&lt;-- I have exactly one child element --></span>
+    &lt;condition boolOperator="AND">        <span class="comment">&lt;-- I have exactly two children elements --></span>
+        &lt;condition boolOperator="OR" ignore="false" expr=.../>
+        &lt;condition boolOperator="OR" ignore="1" expr=.../>
+    &lt;/condition>
+&lt;/condition>
+</pre>
+<p class="caption">An example of a condition object in XML</p>
+
+<p>
+    What this example shows that the ignore attribute, which is a boolean, can have a variety of values, such a "true", "false", "1", "0", etc. 
+    We also see that the first level of condition (with AND operator) has 2 children, but the top level condition has only one children.
+</p>
+
+<p>
+    In JSON, such an object will become this
+</p>
+
+<pre class="code">
+const condition = {
+    condition: {
+        boolOperator: "AND",
+        condition: [
+            { boolOperator: "OR", ignore: "false", expr:"..." },
+            { boolOperator: "OR", ignore: "1", expr:"..." },
+        ]
+    }
+}
+</pre>
+
+<p>
+    As you can see, the SDK did not realize that the ignore property is a boolean, and did not cast it for you. Similarly, it did not 
+    realize that the condition element is a collection (an array), and has generated both an array (for the two OR conditions) and
+    an object (for the AND condition).
+</p>
+
+<p>
+    This can become quickly very hard to use. For instance, if I want to test the ignore boolean, I need to write
+</p>
+
+<pre class="code">
+const ignore = condition.condition.condition[0].ignore;
+if (ignore == "true" || ignore == "1") {
+    ...
+}
+</pre>
+
+
+<p>
+    One would want to simply test ignore as a boolean, and you can (should) use the XTK caster to force the conversion
+</p>
+
+<pre class="code">
+const ignore = XtkCaster.asBoolean(condition.condition.condition[0].ignore);
+if (ignore) {
+    ...
+}
+</pre>
+
+<p>
+    In fact, you should use XtkCaster for the condition objects which are potential arrays, as follows
+</p>
+
+<pre class="code">
+    const ignore = XtkCaster.asBoolean(
+        XtkCaster.asArray(
+            XtkCaster.asArray(condition.condition)
+            .condition
+        )[0].ignore);
+    if (ignore) {
+        ...
+    }
+</pre>
+
+<p>
+    This is a little bit hard to read. It's better to create an object model and make sure data is casted to the proper types
+    as the objects are constructed.
+</p>
+
+<pre class="code">
+const makeCondition = (condition) => {
+    if (condition === null || condition === undefined) return condition;
+    return {
+        boolOperator: XtkCaster.asString(condition.boolOperator),
+        ignore: XtkCaster.asBoolean(condition.ignore),
+        condition: makeCondition(condition.condition);
+    };
+}
+const safeCondition = makeCondition(condition);
+expect(safeCondition.ignore).toBe(false);
+</pre>
+
+
+<p></p>
+<p class="ref">Use the <a href="{{ site.baseurl }}/xtkCaster.html">XTK Caster</a></p>
+<p class="ref">Use the <a href="{{ site.baseurl }}/application.html">Application object</a> to handle schemas</p>
+<p class="ref">Learn about the <a href="{{ site.baseurl }}/xml2json.html">Gotchas of using JSON</a></p>

package/docs/blog.html

@@ -0,0 +1,18 @@
+---
+layout: page
+title: Blog (latest posts)
+---
+
+<div class="blog">
+  <ul>
+    {% for post in site.posts %}
+      <li>
+        <div class="blog-expert">
+          <h2><a href="{{ post.url }}">{{ post.title }}</a></h2>
+          <div class="blog-header">{{ post.author }} - {{ post.date | date_to_string }}</div>
+          {{ post.excerpt }}
+        </div>
+      </li>
+    {% endfor %}
+  </ul>
+</div>

package/docs/buildAndRun.html

@@ -0,0 +1,96 @@
+---
+layout: page
+title: Build &amp Run
+---
+
+<p>To build this project, you need node and npm</p>
+
+<pre class="code">
+npm install
+</pre>
+
+
+<p>Run tests</p>
+<pre class="code">
+npm run unit-tests
+</pre>
+
+<h1>Client Side SDK</h1>
+
+<p>The SDK can also be used client side. </p>
+
+<p>To Compile the client-side SDK, go to the root folder of the SDK and compile the SDK</p>
+<pre class="code">
+node ./compile.js
+</pre>
+
+<p>It generates a file named <b>dist/bundle.js</b></p>
+<pre class="code">
+ACC client-side SDK compiler version 0.1.0
+Bundling ../package.json
+Bundling ./web/jsdom.js
+Bundling ./web/crypto.js
+Bundling ./web/request.js
+Bundling ./xtkCaster.js
+Bundling ./domUtil.js
+Bundling ./xtkEntityCache.js
+Bundling ./methodCache.js
+Bundling ./optionCache.js
+Bundling ./soap.js
+Bundling ./crypto.js
+Bundling ./client.js
+Bundling ./index.js
+Client-side SDK generated in ./dist/bundle.js
+</pre>
+
+
+<h2>Use a proxy</h2>
+<p>Using the client side SDK cannot be done directly because the Campaign server has CORS configured to reject HTTP requests from resources not served by Campaign. 
+    Therefore a server-side proxy is need to relay the calls to Campaign, or you need to serve the SDK and corresponding web pages from Campaign itself</p>
+
+<h2>Deploy the SDK to a Campaign server</h2>
+
+<p>Once compiled, copy it to the Campaign server (here on a dev environment).</p>
+<pre class="code">
+cd /c/cygwin64/home/neolane/ac
+cp "Z:\amorin On My Mac\Documents\dev\git\ac7\acc-js-sdk\dist/bundle.js" nl/web/accSDK.js
+</pre>
+
+<p>This makes them available on the following endpoint</p>
+<pre class="code">
+/nl/accSDK.js
+</pre>
+
+
+
+
+<h2>Usage</h2>
+
+Include the SDK
+<pre class="code">
+&lt;script src="accSDK.js">&lt;/script>
+</pre>
+
+Use the SDK. Note that the SDK variable is now called `document.accSDK` to avoid potential name collision with the common name "sdk".
+<pre class="code">
+&lt;script>
+
+    (async () => {
+        const sdk = document.accSDK;
+
+        const connectionParameters = sdk.ConnectionParameters.ofUserAndPassword(
+                "http://ffdamid:8080", "admin", "admin");
+        const client = await sdk.init(connectionParameters);
+  
+        console.log(sdk.getSDKVersion());
+        await client.logon();
+
+        var databaseId = await client.getOption("XtkDatabaseId");
+        console.log(databaseId);
+        document.getElementById("hello").textContent = databaseId;
+
+        await client.logoff();    
+    })();
+
+    &lt;/script>
+</pre>