@salesforcedevs/docs-components - npm Package Compare versions

Comparing version 0.0.4-beta.0 to 0.0.4

lwc.config.json

@@ -6,3 +6,3 @@ {
     ],
-    "expose": ["doc/container"]
+    "expose": ["doc/container", "doc/contentCallout"]
 }

package.json

 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.0.4-beta.0",
+    "version": "0.0.4",
     "description": "Docs Lightning web components for DSC",
-    "license": "UNLICENSED",
+    "license": "MIT",
     "main": "index.js",
@@ -7,0 +7,0 @@ "engines": {

src/modules/doc/nav/__tests__/nav.test.ts

@@ -10,25 +10,20 @@ import { createElement } from "lwc";
 import mockPageReference from "./mockPageReference";
+import { createRenderComponent } from "utils/tests";
 
-const create = (props?: object) => {
-    const component = createElement("doc-nav", {
-        is: Nav
-    });
+const MOCK_PARAMETERS = {
+    selectedLanguage: mockSelectedLanguage,
+    selectedVersion: mockSelectedVersion,
+    availableLanguages: mockAvailableLanguages,
+    availableVersions: mockAvailableVersions,
+    pdfUrl: mockPdfUrl,
+    toc: mockToc,
+    pageReference: mockPageReference
+};
 
-    Object.assign(component, {
-        selectedLanguage: mockSelectedLanguage,
-        selectedVersion: mockSelectedVersion,
-        availableLanguages: mockAvailableLanguages,
-        availableVersions: mockAvailableVersions,
-        pdfUrl: mockPdfUrl,
-        toc: mockToc,
-        pageReference: mockPageReference,
-        ...(props || {})
-    });
+const TAG = "doc-nav";
+const render = createRenderComponent(TAG, Nav);
 
-    return component;
-};
-
 describe("doc-nav", () => {
     it("renders the navigation", () => {
-        const component = create();
+        const component = render(MOCK_PARAMETERS);
         document.body.appendChild(component);
@@ -40,7 +35,34 @@ const toolbarEl = component.shadowRoot.querySelector("doc-toolbar");
     it("renders the content", () => {
-        const component = create();
-        document.body.appendChild(component);
-        const tocEl = component.shadowRoot.querySelector("doc-toc");
+        const component = render(MOCK_PARAMETERS);
+
+        const tocEl = component.shadowRoot.querySelector("dx-tree");
         expect(tocEl).not.toBeNull();
     });
+
+    it("fires the event", () => {
+        const component = render(MOCK_PARAMETERS);
+
+        const tocEl: HTMLElement = component.shadowRoot.querySelector(
+            "dx-tree"
+        );
+        const mockNavClick = jest.fn();
+        component.addEventListener("navclick", mockNavClick);
+        tocEl.dispatchEvent(
+            new CustomEvent("select", {
+                detail: {
+                    name: "apex_dev_guide-hashtest"
+                },
+                bubbles: true,
+                composed: true
+            })
+        );
+        expect(mockNavClick).toHaveBeenCalledTimes(1);
+        expect(mockNavClick.mock.calls[0][0].detail).toEqual({
+            pageReference: {
+                ...mockPageReference,
+                contentDocumentId: "apex_dev_guide.htm",
+                hash: "hashtest"
+            }
+        });
+    });
 });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Explicitly Unlicensed Item

License

(Experimental) Something was found which is explicitly marked as unlicensed.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Misc. License Issues

License

(Experimental) A package's licensing information has fine-grained problems.

Found 1 instance in 1 package

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

419651

increased by1.96%

Number of package files

62

increased by10.71%

Number of high license alerts

0

decreased by-100%

Number of low license alerts

0

decreased by-100%

Number of medium license alerts

0

decreased by-100%

License quality

100

increased byInfinity%

Lines of code

8120

increased by2.77%

No dependency changes