@salesforcedevs/docs-components 0.5.0-alpha1 → 0.7.0

package/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2020, Salesforce.com, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.5.0-alpha1",
+    "version": "0.7.0",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -14,5 +14,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
+    "gitHead": "924c919f0e9214fffb628926b1ac0ad73f9304b7"
 }

package/src/modules/doc/content/content.ts

@@ -136,8 +136,10 @@ export default class Content extends LightningElement {
             calloutEl.appendChild(calloutCompEl);
         });
 
-        // Modify links to work with any domain
-        const anchorEls = templateEl.content.querySelectorAll("a");
+        // Modify links to work with any domain, links that start with "#" are excluded
+        const anchorEls = templateEl.content.querySelectorAll(
+            "a:not([href^='#'])"
+        );
         anchorEls.forEach((anchorEl) => {
             if (
                 anchorEl.textContent.includes("Next →") ||
@@ -149,6 +151,7 @@ export default class Content extends LightningElement {
                     anchorEl.remove();
                 }
             }
+
             const href = anchorEl.href.split("/");
             if (
                 (href[3] === this.pageReference.docId && this.isStorybook) ||

package/src/modules/doc/header/__tests__/header.test.ts

@@ -11,14 +11,20 @@ import {
 } from "./mockProps";
 import Dropdown from "dx/dropdown";
 import { Option } from "typings/custom";
+import { track } from "dx/instrumentation";
 
 const EXPECTED_QUERY_TABLET = "(max-width: 980px)";
 const EXPECTED_QUERY_MOBILE = "(max-width: 880px)";
 const SMALL_MOBILE_MATCH = "(max-width: 740px)";
 
+jest.mock("dx/instrumentation");
+
 const TAG = "doc-header";
 const render = createRenderComponent(TAG, Header);
 
+const GTM_EVENT_NAME = "custEv_signUpClick";
+const SIGN_UP_LABEL = "Sign Up";
+
 const assertMediaMatchCalls = () => {
     expect(window.matchMedia).toBeCalledTimes(3);
     expect(window.matchMedia).toHaveBeenNthCalledWith(1, EXPECTED_QUERY_MOBILE);
@@ -84,8 +90,14 @@ describe(TAG, () => {
     });
 
     describe("desktop", () => {
+        afterEach(() => {
+            jest.clearAllMocks();
+        });
+
         it("renders", () => {
             const element = render();
+            expect(element.headerHref).toBe("/");
+
             const headerEl: HTMLElement = element.shadowRoot.querySelector(
                 "header"
             );
@@ -280,6 +292,21 @@ describe(TAG, () => {
             expect(headerSearch).toBeNull();
             return expect(element).toBeAccessible();
         });
+
+        it("signup button track is beign called", () => {
+            const element = render(mockPropsDevelopers);
+
+            const button: HTMLElement = element.shadowRoot.querySelector(
+                "dx-button"
+            );
+
+            button.click();
+
+            expect(track).toBeCalledTimes(1);
+            expect(track).toBeCalledWith(button, GTM_EVENT_NAME, {
+                clickText: SIGN_UP_LABEL
+            });
+        });
     });
 
     describe("tablet", () => {

package/src/modules/doc/header/header.html

@@ -33,6 +33,16 @@
                         onstatechange={handleStateChange}
                     ></dx-header-search>
                 </div>
+                <div if:true={showSignup} class="header-login-signup">
+                    <dx-button
+                        aria-label="Sign Up For Salesforce Developer Edition"
+                        size="small"
+                        href={signupLink}
+                        onclick={handleSignUpClick}
+                    >
+                        Sign Up
+                    </dx-button>
+                </div>
                 <dx-header-mobile-nav-menu
                     if:true={hasNavItems}
                     nav-items={navItems}
@@ -55,7 +65,7 @@
             </div>
             <div class="header_l2">
                 <div class="header_l2_group header_l2_group-title">
-                    <a href="/" class="home-link">
+                    <a href={headerHref} class="home-link">
                         <dx-icon
                             class="brand-icon"
                             if:true={isValidBrand}

package/src/modules/doc/header/header.ts

@@ -11,6 +11,7 @@ const SMALL_MOBILE_MATCH = "740px";
 
 export default class Header extends HeaderBase {
     @api langValuePath: string = "id"; // allows to override how language property is interpreted, follows valuePath dropdown api.
+    @api headerHref: string = "/";
 
     @api
     get scopedNavItems() {