@kwiz/common/lib/esm/utils/sharepoint.rest/navigation-links.js

KWIZ common utilities and helpers for M365 platform

import { CommonLogger } from "../../common-logger";
import { isNullOrEmptyString, isNullOrUndefined } from "../../helpers/typecheckers";
import { GetJson } from "../rest";
import { GetRestBaseUrl, GetSiteUrl } from "./common";
const logger = new CommonLogger("utils/sharepoint.rest/navigation-links");
/**
 * Get all navigation links in the top and side navigation of a SharePoint site
 * @param siteUrl The URL of the SharePoint site
 * @returns An array containing all navigation links
 */
export async function GetNavigationLinks(siteUrl) {
    siteUrl = GetSiteUrl(siteUrl);
    const topNavUrl = `${GetRestBaseUrl(siteUrl)}/web/navigation/topnavigationbar`;
    const sideNavUrl = `${GetRestBaseUrl(siteUrl)}/web/navigation/quicklaunch`;
    try {
        const topNavResponse = await GetJson(topNavUrl, null, {
            spWebUrl: siteUrl //allow getDigest to work when not in SharePoint
        });
        const sideNavResponse = await GetJson(sideNavUrl, null, {
            spWebUrl: siteUrl //allow getDigest to work when not in SharePoint
        });
        const topNavLinks = topNavResponse.d.results.map((link) => ({ ...link, Location: "topnavigationbar" }));
        const sideNavLinks = sideNavResponse.d.results.map((link) => ({ ...link, Location: "quicklaunch" }));
        return [...topNavLinks, ...sideNavLinks];
    }
    catch (error) {
        logger.error(`Error fetching navigation links: ${error.message}`);
    }
    return [];
}
/**
 * Add a navigation link to the specified location (top navigation or side navigation)
 * @param title The title of the navigation link
 * @param url The url of the navigation link
 * @param location The location where the link will be added ('topnavigationbar' or 'quicklaunch'). Default is 'quicklaunch'.
 * @Logs If the location is invalid or if adding the link fails
 */
export async function AddNavigationLink(title, url, location = 'quicklaunch') {
    try {
        let siteUrl = GetSiteUrl();
        let navigationUrl = "";
        navigationUrl = `${GetRestBaseUrl(siteUrl)}/web/navigation/${location}`;
        const response = await GetJson(navigationUrl, JSON.stringify({
            '__metadata': { 'type': 'SP.NavigationNode' },
            'Title': title,
            'Url': url
        }), {
            spWebUrl: siteUrl,
        });
        if (!isNullOrUndefined(response) && !isNullOrUndefined(response.d)) {
            return response.d;
        }
    }
    catch (error) {
        logger.error('Error adding link');
    }
}
/**
 * Delete navigation links by title and URL
 * @param navLinks An array of navigation links to be deleted
 * @Logs If the location is invalid or if deleting the links fails
 */
export async function DeleteNavigationLinks(navLinks) {
    try {
        const siteUrl = GetSiteUrl();
        for (const navLink of navLinks) {
            const navigationUrl = `${GetRestBaseUrl(siteUrl)}/web/Navigation/GetNodeById(${navLink.Id})`;
            // Use the same convention to make the DELETE request
            const response = await GetJson(navigationUrl, null, {
                method: 'POST',
                spWebUrl: siteUrl,
                xHttpMethod: 'DELETE'
            });
            if (!isNullOrEmptyString(response) && !response.ok) {
                logger.error('Failed to delete link');
            }
        }
        logger.info('Navigation links deleted successfully');
    }
    catch (error) {
        logger.error('Error deleting links');
    }
}
//# sourceMappingURL=navigation-links.js.map