@salesforcedevs/docs-components 1.16.0 → 1.17.0-edit

package/lwc.config.json

@@ -18,6 +18,7 @@
         "doc/header",
         "doc/heading",
         "doc/headingAnchor",
+        "doc/markdownEditor",
         "doc/overview",
         "doc/phase",
         "doc/specificationContent",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.16.0",
+    "version": "1.17.0-edit",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -25,5 +25,5 @@
         "@types/lodash.orderby": "4.6.9",
         "@types/lodash.uniqby": "4.7.9"
     },
-    "gitHead": "977c82c3a242a1476eee4eee5c70b03472a7492e"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

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

@@ -43,26 +43,10 @@ export default class Content extends LightningElement {
         return this.docContent;
     }
 
-    @api
-    set codeBlockTheme(value) {
-        this._codeBlockTheme = value;
-    }
-
-    get codeBlockTheme() {
-        return this._codeBlockTheme;
-    }
-
     @track docContent: DocContent = "";
-    _codeBlockTheme: string = "dark";
     _docRendered: boolean = false;
-    originalCodeBlockThemeValue: String = "";
 
     connectedCallback() {
-        this.template.addEventListener(
-            "themechange",
-            this.updateTheme.bind(this) // eslint-disableline no-use-before-define
-        );
-
         window.addEventListener(
             "highlightedtermchange",
             this.updateHighlighted
@@ -76,15 +60,6 @@ export default class Content extends LightningElement {
         );
     }
 
-    updateTheme() {
-        this._codeBlockTheme =
-            this._codeBlockTheme === "dark" ? "light" : "dark";
-        const codeBlockEls = this.template.querySelectorAll("dx-code-block");
-        codeBlockEls.forEach((codeBlockEl) => {
-            codeBlockEl.setAttribute("theme", this._codeBlockTheme);
-        });
-    }
-
     renderPaginationButton(anchorEl: HTMLElement) {
         const isNext = anchorEl.textContent!.includes("Next →");
         anchorEl.innerHTML = "";
@@ -116,11 +91,11 @@ export default class Content extends LightningElement {
             const codeBlockEls = divEl.querySelectorAll(".codeSection");
             codeBlockEls.forEach((codeBlockEl) => {
                 codeBlockEl.setAttribute("lwc:dom", "manual");
-                const classList = (codeBlockEl.firstChild as any).classList;
+                const classList = codeBlockEl.firstElementChild?.classList;
                 let language = "";
-                for (const key in classList) {
-                    if (typeof classList[key] === "string") {
-                        const className = classList[key];
+                if (classList) {
+                    for (let i = 0; i < classList.length; i++) {
+                        const className = classList[i];
                         if (className.startsWith("brush:")) {
                             language = className.split(":")[1];
                         }
@@ -133,7 +108,6 @@ export default class Content extends LightningElement {
                     codeBlock: codeBlockEl.innerHTML,
                     // ! Hot fix for incoming html tags from couchdb for xml blocks, fix me soon please
                     language: LANGUAGE_MAP[language] || language,
-                    theme: this.codeBlockTheme,
                     header: "", // Default no title.
                     variant: this.codeBlockType,
                     isEncoded: true
@@ -158,6 +132,7 @@ export default class Content extends LightningElement {
                     }
                 });
 
+                // Set a flag to 1 (true) if and only if all detailEls have no content.
                 let flag = 1;
                 for (let i: number = 0; i < detailEls.length; i++) {
                     flag &= (detailEls[i].innerHTML.trim() === "") as any; // Dark Magic TM
@@ -359,7 +334,7 @@ export default class Content extends LightningElement {
         );
 
     @api
-    public navigateToHash(hash: String) {
+    public navigateToHash = (hash: String) => {
         const splitHash = hash.split("#");
         if (splitHash.length === 2) {
             hash = splitHash[1];
@@ -370,7 +345,7 @@ export default class Content extends LightningElement {
         } else {
             window.scrollTo({ top: 0, behavior: "smooth" });
         }
-    }
+    };
 
     renderedCallback() {
         if (this._docRendered) {

package/src/modules/doc/markdownEditor/markdownEditor.css

@@ -0,0 +1,166 @@
+.markdown-editor {
+    border: 1px solid #e1e5e9;
+    border-radius: 4px;
+    overflow: hidden;
+    background: #fff;
+}
+
+/* Editor Toolbar */
+.editor-toolbar {
+    display: flex;
+    align-items: center;
+    justify-content: flex-end;
+    gap: 0.5rem;
+    padding: 0.75rem 1rem;
+    background: #f8f9fa;
+    border-bottom: 1px solid #e1e5e9;
+    flex-wrap: wrap;
+}
+
+.edit-button,
+.cancel-button,
+.save-button {
+    min-width: 80px;
+}
+
+.status-indicator {
+    margin-left: 0.5rem;
+    font-size: 0.875rem;
+}
+
+.status-saving {
+    color: #0176d3;
+}
+
+.status-success {
+    color: #04844b;
+}
+
+.status-error {
+    color: #ea001e;
+}
+
+/* Content Viewer */
+.content-viewer {
+    padding: 1rem;
+}
+
+.content-display {
+    line-height: 1.6;
+    color: #3e3e3c;
+}
+
+.content-display h1,
+.content-display h2,
+.content-display h3,
+.content-display h4,
+.content-display h5,
+.content-display h6 {
+    margin-top: 1.5rem;
+    margin-bottom: 0.5rem;
+    color: #181818;
+}
+
+.content-display p {
+    margin-bottom: 1rem;
+}
+
+.content-display ul,
+.content-display ol {
+    margin-bottom: 1rem;
+    padding-left: 2rem;
+}
+
+.content-display code {
+    background-color: #f3f2f2;
+    padding: 0.125rem 0.25rem;
+    border-radius: 0.25rem;
+    font-family: Monaco, Menlo, "Ubuntu Mono", monospace;
+    font-size: 0.875rem;
+}
+
+.content-display pre {
+    background-color: #f3f2f2;
+    padding: 1rem;
+    border-radius: 0.25rem;
+    overflow-x: auto;
+    margin-bottom: 1rem;
+}
+
+.content-display pre code {
+    background-color: transparent;
+    padding: 0;
+}
+
+/* Editor Wrapper */
+.editor-wrapper {
+    position: relative;
+    min-height: 300px;
+}
+
+.simple-editor {
+    width: 100%;
+    min-height: 300px;
+    padding: 1rem;
+    border: none;
+    outline: none;
+    font-family: Monaco, Menlo, "Ubuntu Mono", monospace;
+    font-size: 0.875rem;
+    line-height: 1.5;
+    resize: vertical;
+    background: #fff;
+    color: #3e3e3c;
+}
+
+.simple-editor:focus {
+    outline: none;
+}
+
+.simple-editor::placeholder {
+    color: #706e6b;
+}
+
+/* Loading Overlay */
+.loading-overlay {
+    position: absolute;
+    top: 0;
+    left: 0;
+    right: 0;
+    bottom: 0;
+    background: rgb(255 255 255 / 80%);
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    z-index: 1000;
+}
+
+/* Responsive Design */
+@media (max-width: 768px) {
+    .editor-toolbar {
+        flex-wrap: wrap;
+        gap: 0.25rem;
+        justify-content: flex-end;
+    }
+
+    .status-indicator {
+        margin-left: 0.25rem;
+        width: auto;
+        text-align: right;
+        margin-top: 0;
+    }
+
+    .simple-editor {
+        min-height: 250px;
+    }
+
+    .content-viewer {
+        padding: 0.75rem;
+    }
+}
+
+/* Empty state */
+.content-display:empty::before {
+    content: "No content to display";
+    color: #706e6b;
+    font-style: italic;
+}

package/src/modules/doc/markdownEditor/markdownEditor.html

@@ -0,0 +1,68 @@
+<template>
+    <div class="markdown-editor">
+        <!-- Editor Toolbar -->
+        <div class="editor-toolbar">
+            <template if:true={showViewer}>
+                <dx-button
+                    onclick={handleEdit}
+                    variant="tertiary"
+                    class="edit-button"
+                >
+                    Edit Content
+                </dx-button>
+            </template>
+
+            <template if:true={showEditor}>
+                <dx-button
+                    onclick={handleCancel}
+                    variant="secondary"
+                    class="cancel-button"
+                >
+                    Cancel
+                </dx-button>
+
+                <dx-button
+                    onclick={handleSave}
+                    variant="primary"
+                    disabled={saveButtonDisabled}
+                    class="save-button"
+                >
+                    Save
+                </dx-button>
+
+                <div class="status-indicator">
+                    <span class={statusClass}>{statusMessage}</span>
+                </div>
+            </template>
+        </div>
+
+        <!-- Content Viewer (Read-only) -->
+        <template if:true={showViewer}>
+            <div class="content-viewer">
+                <div class="content-display" innerhtml={content}></div>
+            </div>
+        </template>
+
+        <!-- Simple Editor -->
+        <template if:true={showEditor}>
+            <div class="editor-wrapper">
+                <textarea
+                    class="simple-editor"
+                    value={markdownContent}
+                    onchange={handleContentChange}
+                    placeholder="Enter your markdown content here..."
+                ></textarea>
+            </div>
+        </template>
+
+        <!-- Loading Overlay -->
+        <template if:true={isLoading}>
+            <div class="loading-overlay">
+                <dx-spinner
+                    size="medium"
+                    alternative-text="Loading"
+                ></dx-spinner>
+            </div>
+        </template>
+    </div>
+</template>

package/src/modules/doc/markdownEditor/markdownEditor.ts

@@ -0,0 +1,118 @@
+import { LightningElement, api, track } from "lwc";
+
+export default class MarkdownEditor extends LightningElement {
+    @api content: string = "";
+    @api filePath: string = "";
+    @api saveEndpoint: string = "";
+    @api authToken: string = "";
+
+    @track isEditing: boolean = false;
+    @track markdownContent: string = "";
+    @track isLoading: boolean = false;
+    @track saveStatus: "idle" | "saving" | "success" | "error" = "idle";
+
+    connectedCallback() {
+        this.markdownContent = this.content; // Simple fallback for now
+    }
+
+    // Event Handlers
+    handleEdit() {
+        this.isEditing = true;
+        this.saveStatus = "idle";
+    }
+
+    handleCancel() {
+        this.isEditing = false;
+        this.saveStatus = "idle";
+    }
+
+    async handleSave() {
+        if (!this.saveEndpoint) {
+            console.error("Save endpoint not configured");
+            this.saveStatus = "error";
+            return;
+        }
+
+        this.saveStatus = "saving";
+        this.isLoading = true;
+
+        try {
+            const response = await fetch(this.saveEndpoint, {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: this.authToken
+                        ? `Bearer ${this.authToken}`
+                        : ""
+                },
+                body: JSON.stringify({
+                    content: this.markdownContent,
+                    filePath: this.filePath,
+                    originalContent: this.content
+                })
+            });
+
+            if (response.ok) {
+                this.saveStatus = "success";
+                this.isEditing = false;
+
+                // Dispatch save success event
+                this.dispatchEvent(
+                    new CustomEvent("saved", {
+                        detail: {
+                            success: true,
+                            content: this.markdownContent,
+                            filePath: this.filePath
+                        }
+                    })
+                );
+            } else {
+                throw new Error(`Save failed: ${response.status}`);
+            }
+        } catch (error) {
+            console.error("Save failed:", error);
+            this.saveStatus = "error";
+        } finally {
+            this.isLoading = false;
+        }
+    }
+
+    // Getters for UI state
+    get showEditor() {
+        return this.isEditing;
+    }
+
+    get showViewer() {
+        return !this.isEditing;
+    }
+
+    get saveButtonDisabled() {
+        return this.saveStatus === "saving" || this.isLoading;
+    }
+
+    get statusMessage() {
+        switch (this.saveStatus) {
+            case "saving":
+                return "Saving...";
+            case "success":
+                return "Saved successfully!";
+            case "error":
+                return "Save failed. Please try again.";
+            default:
+                return "";
+        }
+    }
+
+    get statusClass() {
+        switch (this.saveStatus) {
+            case "saving":
+                return "status-saving";
+            case "success":
+                return "status-success";
+            case "error":
+                return "status-error";
+            default:
+                return "";
+        }
+    }
+}

package/LICENSE

@@ -1,12 +0,0 @@
-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.