@kwiz/common 1.0.30 → 1.0.31

package/dist/types/sharepoint.types.d.ts

@@ -1461,4 +1461,14 @@ export type IRententionLabel = {
     TagRetentionBasedOn: string;
     UnlockedAsDefault: boolean;
 };
+export type spNavLinkLocation = "quicklaunch" | "topnavigationbar" | "none";
+export interface INavLinkInfo {
+    Id: number;
+    IsDocLib: boolean;
+    IsExternal: boolean;
+    IsVisible: boolean;
+    Title: string;
+    Url: string;
+    Location: spNavLinkLocation;
+}
 export {};

package/dist/utils/sharepoint.rest/exports-index.d.ts

@@ -4,6 +4,7 @@ export * from './date';
 export * from './file.folder';
 export * from './item';
 export * from './list';
+export * from './navigation-links';
 export * from './user-search';
 export * from './user';
 export * from './web';

package/dist/utils/sharepoint.rest/exports-index.js

@@ -20,6 +20,7 @@ __exportStar(require("./date"), exports);
 __exportStar(require("./file.folder"), exports);
 __exportStar(require("./item"), exports);
 __exportStar(require("./list"), exports);
+__exportStar(require("./navigation-links"), exports);
 __exportStar(require("./user-search"), exports);
 __exportStar(require("./user"), exports);
 __exportStar(require("./web"), exports);

package/dist/utils/sharepoint.rest/exports-index.js.map

@@ -1 +1 @@
-{"version":3,"file":"exports-index.js","sourceRoot":"","sources":["../../../src/utils/sharepoint.rest/exports-index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,2CAAyB;AACzB,yCAAuB;AACvB,gDAA8B;AAC9B,yCAAuB;AACvB,yCAAuB;AACvB,gDAA8B;AAC9B,yCAAuB;AACvB,wCAAsB"}
+{"version":3,"file":"exports-index.js","sourceRoot":"","sources":["../../../src/utils/sharepoint.rest/exports-index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,2CAAyB;AACzB,yCAAuB;AACvB,gDAA8B;AAC9B,yCAAuB;AACvB,yCAAuB;AACvB,qDAAmC;AACnC,gDAA8B;AAC9B,yCAAuB;AACvB,wCAAsB"}

package/dist/utils/sharepoint.rest/navigation-links.d.ts

@@ -0,0 +1,21 @@
+import { INavLinkInfo } from "../_dependencies";
+/**
+ * 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 declare function GetNavigationLinks(siteUrl?: string): Promise<INavLinkInfo[]>;
+/**
+ * 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 declare function AddNavigationLink(location?: string): Promise<INavLinkInfo>;
+/**
+ * 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 declare function DeleteNavigationLinks(navLinks: INavLinkInfo[]): Promise<void>;

package/dist/utils/sharepoint.rest/navigation-links.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeleteNavigationLinks = exports.AddNavigationLink = exports.GetNavigationLinks = void 0;
+const _dependencies_1 = require("../_dependencies");
+const consolelogger_1 = require("../consolelogger");
+const rest_1 = require("../rest");
+const common_1 = require("./common");
+const logger = consolelogger_1.ConsoleLogger.get("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
+ */
+async function GetNavigationLinks(siteUrl) {
+    siteUrl = (0, common_1.GetSiteUrl)(siteUrl);
+    const topNavUrl = `${(0, common_1.GetRestBaseUrl)(siteUrl)}/web/navigation/topnavigationbar`;
+    const sideNavUrl = `${(0, common_1.GetRestBaseUrl)(siteUrl)}/web/navigation/quicklaunch`;
+    try {
+        const topNavResponse = await (0, rest_1.GetJson)(topNavUrl);
+        const sideNavResponse = await (0, rest_1.GetJson)(sideNavUrl);
+        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 [];
+}
+exports.GetNavigationLinks = GetNavigationLinks;
+/**
+ * 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
+ */
+async function AddNavigationLink(location = 'quicklaunch') {
+    try {
+        let siteUrl = (0, common_1.GetSiteUrl)();
+        let navigationUrl = "";
+        navigationUrl = `${(0, common_1.GetRestBaseUrl)(siteUrl)}/web/navigation/${location}`;
+        const response = await (0, rest_1.GetJson)(navigationUrl, JSON.stringify({
+            '__metadata': { 'type': 'SP.NavigationNode' },
+            'Title': "CMS365",
+            'Url': `${(0, _dependencies_1.normalizeUrl)(siteUrl, true)}SitePages/cms365.aspx`
+        }), {
+            spWebUrl: siteUrl,
+        });
+        if (!(0, _dependencies_1.isNullOrUndefined)(response) && !(0, _dependencies_1.isNullOrUndefined)(response.d)) {
+            return response.d;
+        }
+    }
+    catch (error) {
+        logger.error('Error adding link');
+    }
+}
+exports.AddNavigationLink = AddNavigationLink;
+/**
+ * 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
+ */
+async function DeleteNavigationLinks(navLinks) {
+    try {
+        const siteUrl = (0, common_1.GetSiteUrl)();
+        for (const navLink of navLinks) {
+            const navigationUrl = `${(0, common_1.GetRestBaseUrl)(siteUrl)}/web/Navigation/GetNodeById(${navLink.Id})`;
+            // Use the same convention to make the DELETE request
+            const response = await (0, rest_1.GetJson)(navigationUrl, null, {
+                method: 'POST',
+                spWebUrl: siteUrl,
+                xHttpMethod: 'DELETE'
+            });
+            if (!(0, _dependencies_1.isNullOrEmptyString)(response) && !response.ok) {
+                logger.error('Failed to delete link');
+            }
+        }
+        logger.info('Navigation links deleted successfully');
+    }
+    catch (error) {
+        logger.error('Error deleting links');
+    }
+}
+exports.DeleteNavigationLinks = DeleteNavigationLinks;
+//# sourceMappingURL=navigation-links.js.map

package/dist/utils/sharepoint.rest/navigation-links.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigation-links.js","sourceRoot":"","sources":["../../../src/utils/sharepoint.rest/navigation-links.ts"],"names":[],"mappings":";;;AAAA,oDAAsG;AACtG,oDAAiD;AACjD,kCAAkC;AAClC,qCAAsD;AAEtD,MAAM,MAAM,GAAG,6BAAa,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;AAErE;;;;GAIG;AACI,KAAK,UAAU,kBAAkB,CAAC,OAAgB;IACrD,OAAO,GAAG,IAAA,mBAAU,EAAC,OAAO,CAAC,CAAC;IAC9B,MAAM,SAAS,GAAG,GAAG,IAAA,uBAAc,EAAC,OAAO,CAAC,kCAAkC,CAAC;IAC/E,MAAM,UAAU,GAAG,GAAG,IAAA,uBAAc,EAAC,OAAO,CAAC,6BAA6B,CAAC;IAE3E,IAAI,CAAC;QACD,MAAM,cAAc,GAAG,MAAM,IAAA,cAAO,EAAqC,SAAS,CAAC,CAAC;QACpF,MAAM,eAAe,GAAG,MAAM,IAAA,cAAO,EAAqC,UAAU,CAAC,CAAC;QAEtF,MAAM,WAAW,GAAmB,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAkB,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;QACtI,MAAM,YAAY,GAAmB,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAkB,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;QAEnI,OAAO,CAAC,GAAG,WAAW,EAAE,GAAG,YAAY,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,CAAC,KAAK,CAAC,oCAAoC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,EAAE,CAAC;AACd,CAAC;AAjBD,gDAiBC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,iBAAiB,CAAC,WAAmB,aAAa;IACpE,IAAI,CAAC;QACD,IAAI,OAAO,GAAG,IAAA,mBAAU,GAAE,CAAC;QAC3B,IAAI,aAAa,GAAG,EAAE,CAAC;QACvB,aAAa,GAAG,GAAG,IAAA,uBAAc,EAAC,OAAO,CAAC,mBAAmB,QAAQ,EAAE,CAAC;QACxE,MAAM,QAAQ,GAAG,MAAM,IAAA,cAAO,EAAsB,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC;YAC9E,YAAY,EAAE,EAAE,MAAM,EAAE,mBAAmB,EAAE;YAC7C,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,GAAG,IAAA,4BAAY,EAAC,OAAO,EAAE,IAAI,CAAC,uBAAuB;SAC/D,CAAC,EAAE;YACA,QAAQ,EAAE,OAAO;SACpB,CAAC,CAAC;QAGH,IAAI,CAAC,IAAA,iCAAiB,EAAC,QAAQ,CAAC,IAAI,CAAC,IAAA,iCAAiB,EAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;YACjE,OAAO,QAAQ,CAAC,CAAC,CAAC;QACtB,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACtC,CAAC;AACL,CAAC;AApBD,8CAoBC;AAED;;;;GAIG;AACI,KAAK,UAAU,qBAAqB,CAAC,QAAwB;IAChE,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,IAAA,mBAAU,GAAE,CAAC;QAC7B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,MAAM,aAAa,GAAG,GAAG,IAAA,uBAAc,EAAC,OAAO,CAAC,+BAA+B,OAAO,CAAC,EAAE,GAAG,CAAC;YAC7F,qDAAqD;YACrD,MAAM,QAAQ,GAAG,MAAM,IAAA,cAAO,EAAM,aAAa,EAAE,IAAI,EAAE;gBACrD,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,OAAO;gBACjB,WAAW,EAAE,QAAQ;aACxB,CAAC,CAAC;YAEH,IAAI,CAAC,IAAA,mCAAmB,EAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjD,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC1C,CAAC;QACL,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACzC,CAAC;AACL,CAAC;AApBD,sDAoBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kwiz/common",
-  "version": "1.0.30",
+  "version": "1.0.31",
   "description": "KWIZ common utilities and helpers for M365 platform",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/types/sharepoint.types.ts

@@ -1445,3 +1445,15 @@ export type IRententionLabel = {
     TagRetentionBasedOn: string;
     UnlockedAsDefault: boolean;
 }
+
+export type spNavLinkLocation = "quicklaunch" | "topnavigationbar" | "none";
+
+export interface INavLinkInfo {
+    Id: number;
+    IsDocLib: boolean;
+    IsExternal: boolean;
+    IsVisible: boolean;
+    Title: string;
+    Url: string;
+    Location: spNavLinkLocation;
+}

package/src/utils/sharepoint.rest/exports-index.ts

@@ -4,6 +4,7 @@ export * from './date';
 export * from './file.folder';
 export * from './item';
 export * from './list';
+export * from './navigation-links';
 export * from './user-search';
 export * from './user';
 export * from './web';

package/src/utils/sharepoint.rest/navigation-links.ts

@@ -0,0 +1,86 @@
+import { INavLinkInfo, isNullOrEmptyString, isNullOrUndefined, normalizeUrl } from "../_dependencies";
+import { ConsoleLogger } from "../consolelogger";
+import { GetJson } from "../rest";
+import { GetRestBaseUrl, GetSiteUrl } from "./common";
+
+const logger = ConsoleLogger.get("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?: string): Promise<INavLinkInfo[]> {
+    siteUrl = GetSiteUrl(siteUrl);
+    const topNavUrl = `${GetRestBaseUrl(siteUrl)}/web/navigation/topnavigationbar`;
+    const sideNavUrl = `${GetRestBaseUrl(siteUrl)}/web/navigation/quicklaunch`;
+
+    try {
+        const topNavResponse = await GetJson<{ d: { results: INavLinkInfo[] } }>(topNavUrl);
+        const sideNavResponse = await GetJson<{ d: { results: INavLinkInfo[] } }>(sideNavUrl);
+
+        const topNavLinks: INavLinkInfo[] = topNavResponse.d.results.map((link: INavLinkInfo) => ({ ...link, Location: "topnavigationbar" }));
+        const sideNavLinks: INavLinkInfo[] = sideNavResponse.d.results.map((link: INavLinkInfo) => ({ ...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(location: string = 'quicklaunch'): Promise<INavLinkInfo> {
+    try {
+        let siteUrl = GetSiteUrl();
+        let navigationUrl = "";
+        navigationUrl = `${GetRestBaseUrl(siteUrl)}/web/navigation/${location}`;
+        const response = await GetJson<{ d: INavLinkInfo }>(navigationUrl, JSON.stringify({
+            '__metadata': { 'type': 'SP.NavigationNode' },
+            'Title': "CMS365",
+            'Url': `${normalizeUrl(siteUrl, true)}SitePages/cms365.aspx`
+        }), {
+            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: INavLinkInfo[]): Promise<void> {
+    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<any>(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');
+    }
+}