@salesforcedevs/docs-components 0.54.7-alpha → 0.55.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.54.7-alpha",
+    "version": "0.55.0",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -24,5 +24,5 @@
         "@types/lodash.orderby": "^4.6.7",
         "@types/lodash.uniqby": "^4.7.7"
     },
-    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
+    "gitHead": "4605730d0e1fbcfb0535d2b97424dc61678cd918"
 }

package/src/modules/doc/content/content.css

@@ -66,31 +66,47 @@ td > img.content-image:first-child:last-child[alt="No"] {
 
 h1 {
     font-family: var(--dx-g-font-display);
-    font-size: 40px;
+    font-size: var(--dx-g-text-4xl);
 
     /* not registered */
     color: var(--dx-g-blue-vibrant-20);
     letter-spacing: -0.4px;
-    line-height: 40px;
+    line-height: 56px;
 }
 
 h2 {
     font-family: var(--dx-g-font-display);
-    font-size: var(--dx-g-text-xl);
+    font-size: var(--dx-g-text-3xl);
     color: var(--dx-g-blue-vibrant-20);
     letter-spacing: -0.1px;
-    line-height: var(--dx-g-spacing-lg);
+    line-height: var(--dx-g-spacing-3xl);
 }
 
 h3 {
     font-family: var(--dx-g-font-display);
-    font-size: var(--dx-g-text-lg);
+    font-size: 32px;
     color: var(--dx-g-blue-vibrant-20);
     letter-spacing: -0.1px;
-    line-height: var(--dx-g-spacing-lg);
+    line-height: var(--dx-g-spacing-2xl);
 }
 
 h4 {
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-xl);
+    color: var(--dx-g-blue-vibrant-20);
+    letter-spacing: 0;
+    line-height: var(--dx-g-spacing-xl);
+}
+
+h5 {
+    font-family: var(--dx-g-font-display);
+    font-size: var(--dx-g-text-lg);
+    color: var(--dx-g-blue-vibrant-20);
+    letter-spacing: 0;
+    line-height: 28px;
+}
+
+h6 {
     font-family: var(--dx-g-font-display);
     font-size: var(--dx-g-text-base);
     color: var(--dx-g-blue-vibrant-20);
@@ -116,6 +132,12 @@ p,
     margin-bottom: var(--dx-g-spacing-md);
 }
 
+dd > p,
+dd > .p {
+    margin-top: 0;
+    margin-bottom: 0;
+}
+
 .li {
     font-family: var(--dx-g-font-sans);
     font-size: var(--dx-g-text-base);
@@ -175,7 +197,8 @@ a,
     margin-right: var(--dx-g-spacing-lg);
 }
 
-.codeph {
+.codeph,
+.filepath {
     font-family: var(--dx-g-font-mono);
     font-size: var(--dx-g-text-sm);
     line-height: var(--dx-g-text-lg);
@@ -239,6 +262,7 @@ dd {
     letter-spacing: 0;
     line-height: var(--dx-g-spacing-lg);
     margin-left: var(--dx-g-spacing-smd);
+    margin-bottom: var(--dx-g-spacing-md);
 }
 
 li {

package/src/modules/doc/xmlContent/types.ts

@@ -21,6 +21,12 @@ export enum HistoryState {
     REPLACE_STATE = "replaceState"
 }
 
+export type Labels = {
+    language_english: string;
+    language_japanese: string;
+    toc_title: string;
+};
+
 export type TreeNode = {
     label: string;
     name: string;

package/src/modules/doc/xmlContent/utils.ts

@@ -8,18 +8,22 @@ import {
     DocumentData,
     DocLanguage,
     DocVersion,
+    Labels,
     TreeNode
 } from "./types";
-import { Language } from "typings/custom";
-import { getLanguageDisplayTextById } from "dxUtils/language";
+
+const LOCALE_TO_LABEL = {
+    "en-us": "language_english",
+    "ja-jp": "language_japanese"
+};
 
 export class FetchContent {
     private apiDomain: string;
-    private languages: Array<Language> = [];
+    private labels: Labels;
 
-    constructor(apiDomain: string, languages: Array<Language>) {
+    constructor(apiDomain: string, labels: Labels) {
         this.apiDomain = apiDomain;
-        this.languages = languages;
+        this.labels = labels;
     }
 
     async fetchDocumentData(docId: string): Promise<DocumentData | null> {
@@ -144,10 +148,11 @@ export class FetchContent {
     }
 
     private normalizeLanguage(language: ApiDocLanguage): DocLanguage {
-
+        const labelKey = language.locale && LOCALE_TO_LABEL[language.locale];
         return (
             language && {
-                label: getLanguageDisplayTextById(this.languages, language.locale) || 
+                label:
+                    (labelKey && this.labels && this.labels[labelKey]) ||
                     language.label,
                 id: language.locale,
                 code: language.code,

package/src/modules/doc/xmlContent/xmlContent.ts

@@ -5,6 +5,7 @@ import {
     CoveoAdvancedQueryXMLConfig,
     DocLanguage,
     DocVersion,
+    Labels,
     TreeNode,
     Header,
     HistoryState,
@@ -12,7 +13,6 @@ import {
 } from "./types";
 import { SearchSyncer } from "docUtils/SearchSyncer";
 import { LightningElementWithState } from "docBaseElements/lightningElementWithState";
-import { Language } from "typings/custom";
 
 // TODO: Imitating from actual implementation as doc-content use it like this. We should refactor it later.
 const handleContentError = (error): void => console.log(error);
@@ -35,17 +35,6 @@ export default class DocXmlContent extends LightningElementWithState<{
         this._labels = toJson(value);
     }
 
-    @api
-    get allLanguages(): Array<Language> {
-        return this._allLanguages;
-    }
-
-    set allLanguages(value: string) {
-        if (value) {
-            this._allLanguages = JSON.parse(value);
-        }
-    }
-
     private _labels: Labels = null;
     private availableLanguages: Array<DocLanguage> = [];
     private availableVersions: Array<DocVersion> = [];
@@ -98,7 +87,6 @@ export default class DocXmlContent extends LightningElementWithState<{
         shouldStopPropagation: true,
         target: window
     });
-    private _allLanguages: Array<Language> = [];
 
     @track private pageReference: PageReference = {};
 
@@ -121,7 +109,8 @@ export default class DocXmlContent extends LightningElementWithState<{
             window.location.href = "/docs";
             return;
         }
-        this.contentProvider = new FetchContent(this.apiDomain, this.allLanguages);
+
+        this.contentProvider = new FetchContent(this.apiDomain, this._labels);
         this.fetchDocument().then(() => (this.loaded = true));
         window.addEventListener("popstate", this.handlePopState);