@pnp/sp 2.10.0 → 2.11.0

package/lists/web.d.ts

@@ -1,44 +1,44 @@
-import { ILists, IList } from "./types.js";
-import { ISharePointQueryableCollection } from "../sharepointqueryable.js";
-declare module "../webs/types" {
-    interface _Web {
-        readonly lists: ILists;
-        readonly siteUserInfoList: IList;
-        readonly defaultDocumentLibrary: IList;
-        readonly customListTemplates: ISharePointQueryableCollection;
-        getList(listRelativeUrl: string): IList;
-        getCatalog(type: number): Promise<IList>;
-    }
-    interface IWeb {
-        /**
-         * Gets the collection of all lists that are contained in the Web site
-         */
-        readonly lists: ILists;
-        /**
-         * Gets the UserInfo list of the site collection that contains the Web site
-         */
-        readonly siteUserInfoList: IList;
-        /**
-         * Get a reference the default documents library of a web
-         */
-        readonly defaultDocumentLibrary: IList;
-        /**
-         * Gets the collection of all list definitions and list templates that are available
-         */
-        readonly customListTemplates: ISharePointQueryableCollection;
-        /**
-         * Gets a list by server relative url (list's root folder)
-         *
-         * @param listRelativeUrl The server relative path to the list's root folder (including /sites/ if applicable)
-         */
-        getList(listRelativeUrl: string): IList;
-        /**
-         * Returns the list gallery on the site
-         *
-         * @param type The gallery type - WebTemplateCatalog = 111, WebPartCatalog = 113 ListTemplateCatalog = 114,
-         * MasterPageCatalog = 116, SolutionCatalog = 121, ThemeCatalog = 123, DesignCatalog = 124, AppDataCatalog = 125
-         */
-        getCatalog(type: number): Promise<IList>;
-    }
-}
+import { ILists, IList } from "./types.js";
+import { ISharePointQueryableCollection } from "../sharepointqueryable.js";
+declare module "../webs/types" {
+    interface _Web {
+        readonly lists: ILists;
+        readonly siteUserInfoList: IList;
+        readonly defaultDocumentLibrary: IList;
+        readonly customListTemplates: ISharePointQueryableCollection;
+        getList(listRelativeUrl: string): IList;
+        getCatalog(type: number): Promise<IList>;
+    }
+    interface IWeb {
+        /**
+         * Gets the collection of all lists that are contained in the Web site
+         */
+        readonly lists: ILists;
+        /**
+         * Gets the UserInfo list of the site collection that contains the Web site
+         */
+        readonly siteUserInfoList: IList;
+        /**
+         * Get a reference the default documents library of a web
+         */
+        readonly defaultDocumentLibrary: IList;
+        /**
+         * Gets the collection of all list definitions and list templates that are available
+         */
+        readonly customListTemplates: ISharePointQueryableCollection;
+        /**
+         * Gets a list by server relative url (list's root folder)
+         *
+         * @param listRelativeUrl The server relative path to the list's root folder (including /sites/ if applicable)
+         */
+        getList(listRelativeUrl: string): IList;
+        /**
+         * Returns the list gallery on the site
+         *
+         * @param type The gallery type - WebTemplateCatalog = 111, WebPartCatalog = 113 ListTemplateCatalog = 114,
+         * MasterPageCatalog = 116, SolutionCatalog = 121, ThemeCatalog = 123, DesignCatalog = 124, AppDataCatalog = 125
+         */
+        getCatalog(type: number): Promise<IList>;
+    }
+}
 //# sourceMappingURL=web.d.ts.map

package/lists/web.js

@@ -1,28 +1,28 @@
-import { __awaiter, __generator } from "tslib";
-import { addProp } from "@pnp/odata";
-import { _Web, Web } from "../webs/types.js";
-import { Lists, List } from "./types.js";
-import { odataUrlFrom } from "../odata.js";
-import { SharePointQueryableCollection } from "../sharepointqueryable.js";
-import { escapeQueryStrValue } from "../utils/escapeQueryStrValue.js";
-addProp(_Web, "lists", Lists);
-addProp(_Web, "siteUserInfoList", List, "siteuserinfolist");
-addProp(_Web, "defaultDocumentLibrary", List, "DefaultDocumentLibrary");
-addProp(_Web, "customListTemplates", SharePointQueryableCollection, "getcustomlisttemplates");
-_Web.prototype.getList = function (listRelativeUrl) {
-    return List(this, "getList('" + escapeQueryStrValue(listRelativeUrl) + "')");
-};
-_Web.prototype.getCatalog = function (type) {
-    return __awaiter(this, void 0, void 0, function () {
-        var data;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, this.clone(Web, "getcatalog(" + type + ")").select("Id").get()];
-                case 1:
-                    data = _a.sent();
-                    return [2 /*return*/, List(odataUrlFrom(data))];
-            }
-        });
-    });
-};
+import { __awaiter, __generator } from "tslib";
+import { addProp } from "@pnp/odata";
+import { _Web, Web } from "../webs/types.js";
+import { Lists, List } from "./types.js";
+import { odataUrlFrom } from "../odata.js";
+import { SharePointQueryableCollection } from "../sharepointqueryable.js";
+import { escapeQueryStrValue } from "../utils/escapeQueryStrValue.js";
+addProp(_Web, "lists", Lists);
+addProp(_Web, "siteUserInfoList", List, "siteuserinfolist");
+addProp(_Web, "defaultDocumentLibrary", List, "DefaultDocumentLibrary");
+addProp(_Web, "customListTemplates", SharePointQueryableCollection, "getcustomlisttemplates");
+_Web.prototype.getList = function (listRelativeUrl) {
+    return List(this, "getList('" + escapeQueryStrValue(listRelativeUrl) + "')");
+};
+_Web.prototype.getCatalog = function (type) {
+    return __awaiter(this, void 0, void 0, function () {
+        var data;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, this.clone(Web, "getcatalog(" + type + ")").select("Id").get()];
+                case 1:
+                    data = _a.sent();
+                    return [2 /*return*/, List(odataUrlFrom(data))];
+            }
+        });
+    });
+};
 //# sourceMappingURL=web.js.map

package/navigation/index.d.ts

@@ -1,9 +1,9 @@
-import { INavigationService } from "./types.js";
-import "./web.js";
-export { INavNodeUpdateResult, INavigation, INavigationNode, INavigationNodeAddResult, INavigationNodes, INavigationService, Navigation, NavigationNode, NavigationNodes, NavigationService, IMenuNode, IMenuNodeCollection, ISerializableNavigationNode, INavNodeInfo, } from "./types.js";
-declare module "../rest" {
-    interface SPRest {
-        readonly navigation: INavigationService;
-    }
-}
+import { INavigationService } from "./types.js";
+import "./web.js";
+export { INavNodeUpdateResult, INavigation, INavigationNode, INavigationNodeAddResult, INavigationNodes, INavigationService, Navigation, NavigationNode, NavigationNodes, NavigationService, IMenuNode, IMenuNodeCollection, ISerializableNavigationNode, INavNodeInfo, } from "./types.js";
+declare module "../rest" {
+    interface SPRest {
+        readonly navigation: INavigationService;
+    }
+}
 //# sourceMappingURL=index.d.ts.map

package/navigation/index.js

@@ -1,15 +1,15 @@
-import { SPRest } from "../rest.js";
-import { NavigationService } from "./types.js";
-import "./web.js";
-export { Navigation, NavigationNode, NavigationNodes, NavigationService, } from "./types.js";
-Reflect.defineProperty(SPRest.prototype, "navigation", {
-    configurable: true,
-    enumerable: true,
-    get: function () {
-        return this.childConfigHook(function (_a) {
-            var options = _a.options, baseUrl = _a.baseUrl, runtime = _a.runtime;
-            return NavigationService(baseUrl).configure(options).setRuntime(runtime);
-        });
-    },
-});
+import { SPRest } from "../rest.js";
+import { NavigationService } from "./types.js";
+import "./web.js";
+export { Navigation, NavigationNode, NavigationNodes, NavigationService, } from "./types.js";
+Reflect.defineProperty(SPRest.prototype, "navigation", {
+    configurable: true,
+    enumerable: true,
+    get: function () {
+        return this.childConfigHook(function (_a) {
+            var options = _a.options, baseUrl = _a.baseUrl, runtime = _a.runtime;
+            return NavigationService(baseUrl).configure(options).setRuntime(runtime);
+        });
+    },
+});
 //# sourceMappingURL=index.js.map

package/navigation/types.d.ts

@@ -1,155 +1,155 @@
-import { _SharePointQueryableInstance, _SharePointQueryableCollection, _SharePointQueryable, IDeleteable } from "../sharepointqueryable.js";
-/**
- * Represents a collection of navigation nodes
- *
- */
-export declare class _NavigationNodes extends _SharePointQueryableCollection<INavNodeInfo[]> {
-    /**
-     * Gets a navigation node by id
-     *
-     * @param id The id of the node
-     */
-    getById(id: number): INavigationNode;
-    /**
-     * Adds a new node to the collection
-     *
-     * @param title Display name of the node
-     * @param url The url of the node
-     * @param visible If true the node is visible, otherwise it is hidden (default: true)
-     */
-    add(title: string, url: string, visible?: boolean): Promise<INavigationNodeAddResult>;
-    /**
-     * Moves a node to be after another node in the navigation
-     *
-     * @param nodeId Id of the node to move
-     * @param previousNodeId Id of the node after which we move the node specified by nodeId
-     */
-    moveAfter(nodeId: number, previousNodeId: number): Promise<void>;
-}
-export interface INavigationNodes extends _NavigationNodes {
-}
-export declare const NavigationNodes: import("../sharepointqueryable.js").ISPInvokableFactory<INavigationNodes>;
-/**
- * Represents an instance of a navigation node
- *
- */
-export declare class _NavigationNode extends _SharePointQueryableInstance<INavNodeInfo> {
-    delete: (this: import("../sharepointqueryable.js").ISharePointQueryable<any>) => Promise<void>;
-    /**
-     * Represents the child nodes of this node
-     */
-    get children(): INavigationNodes;
-    /**
-     * Updates this node
-     *
-     * @param properties Properties used to update this node
-     */
-    update(properties: Partial<INavNodeInfo>): Promise<INavNodeUpdateResult>;
-}
-export interface INavigationNode extends _NavigationNode, IDeleteable {
-}
-export declare const NavigationNode: import("../sharepointqueryable.js").ISPInvokableFactory<INavigationNode>;
-export interface INavNodeUpdateResult {
-    data: any;
-    node: INavigationNode;
-}
-/**
- * Exposes the navigation components
- *
- */
-export declare class _Navigation extends _SharePointQueryable {
-    /**
-     * Gets the quicklaunch navigation nodes for the current context
-     *
-     */
-    get quicklaunch(): INavigationNodes;
-    /**
-     * Gets the top bar navigation nodes for the current context
-     *
-     */
-    get topNavigationBar(): INavigationNodes;
-}
-export interface INavigation {
-    readonly quicklaunch: INavigationNodes;
-    readonly topNavigationBar: INavigationNodes;
-}
-export declare const Navigation: import("../sharepointqueryable.js").ISPInvokableFactory<INavigation>;
-/**
- * Represents the top level navigation service
- */
-export declare class _NavigationService extends _SharePointQueryable {
-    constructor(path?: string);
-    /**
-     * The MenuState service operation returns a Menu-State (dump) of a SiteMapProvider on a site.
-     *
-     * @param menuNodeKey MenuNode.Key of the start node within the SiteMapProvider If no key is provided the SiteMapProvider.RootNode will be the root of the menu state.
-     * @param depth Depth of the dump. If no value is provided a dump with the depth of 10 is returned
-     * @param mapProviderName The name identifying the SiteMapProvider to be used
-     * @param customProperties comma seperated list of custom properties to be returned.
-     */
-    getMenuState(menuNodeKey?: string, depth?: number, mapProviderName?: string, customProperties?: string): Promise<IMenuNodeCollection>;
-    /**
-     * Tries to get a SiteMapNode.Key for a given URL within a site collection.
-     *
-     * @param currentUrl A url representing the SiteMapNode
-     * @param mapProviderName The name identifying the SiteMapProvider to be used
-     */
-    getMenuNodeKey(currentUrl: string, mapProviderName?: string): Promise<string>;
-}
-export interface INavigationService extends _NavigationService {
-}
-export declare const NavigationService: (path?: string) => INavigationService;
-export interface IMenuNode {
-    CustomProperties: any[];
-    FriendlyUrlSegment: string;
-    IsDeleted: boolean;
-    IsHidden: boolean;
-    Key: string;
-    Nodes: IMenuNode[];
-    NodeType: number;
-    SimpleUrl: string;
-    Title: string;
-}
-export interface IMenuNodeCollection {
-    FriendlyUrlPrefix: string;
-    Nodes: IMenuNode[];
-    SimpleUrl: string;
-    SPSitePrefix: string;
-    SPWebPrefix: string;
-    StartingNodeKey: string;
-    StartingNodeTitle: string;
-    Version: Date;
-}
-export interface ISerializableNavigationNode {
-    Id: number;
-    Title: string;
-    Url: string;
-    IsDocLib: boolean;
-    IsExternal: boolean;
-    ParentId: number;
-    ListTemplateType: number;
-    AudienceIds: string[];
-    Children: ISerializableNavigationNode[];
-}
-/**
- * Result from adding a navigation node
- *
- */
-export interface INavigationNodeAddResult {
-    data: INavNodeInfo;
-    node: INavigationNode;
-}
-/**
- * Represents the information describing a navigation node
- */
-export interface INavNodeInfo {
-    AudienceIds: string[] | null;
-    Id: number;
-    IsDocLib: boolean;
-    IsExternal: boolean;
-    IsVisible: boolean;
-    ListTemplateType: number;
-    Title: string;
-    Url: string;
-}
+import { _SharePointQueryableInstance, _SharePointQueryableCollection, _SharePointQueryable, IDeleteable } from "../sharepointqueryable.js";
+/**
+ * Represents a collection of navigation nodes
+ *
+ */
+export declare class _NavigationNodes extends _SharePointQueryableCollection<INavNodeInfo[]> {
+    /**
+     * Gets a navigation node by id
+     *
+     * @param id The id of the node
+     */
+    getById(id: number): INavigationNode;
+    /**
+     * Adds a new node to the collection
+     *
+     * @param title Display name of the node
+     * @param url The url of the node
+     * @param visible If true the node is visible, otherwise it is hidden (default: true)
+     */
+    add(title: string, url: string, visible?: boolean): Promise<INavigationNodeAddResult>;
+    /**
+     * Moves a node to be after another node in the navigation
+     *
+     * @param nodeId Id of the node to move
+     * @param previousNodeId Id of the node after which we move the node specified by nodeId
+     */
+    moveAfter(nodeId: number, previousNodeId: number): Promise<void>;
+}
+export interface INavigationNodes extends _NavigationNodes {
+}
+export declare const NavigationNodes: import("../sharepointqueryable.js").ISPInvokableFactory<INavigationNodes>;
+/**
+ * Represents an instance of a navigation node
+ *
+ */
+export declare class _NavigationNode extends _SharePointQueryableInstance<INavNodeInfo> {
+    delete: (this: import("../sharepointqueryable.js").ISharePointQueryable<any>) => Promise<void>;
+    /**
+     * Represents the child nodes of this node
+     */
+    get children(): INavigationNodes;
+    /**
+     * Updates this node
+     *
+     * @param properties Properties used to update this node
+     */
+    update(properties: Partial<INavNodeInfo>): Promise<INavNodeUpdateResult>;
+}
+export interface INavigationNode extends _NavigationNode, IDeleteable {
+}
+export declare const NavigationNode: import("../sharepointqueryable.js").ISPInvokableFactory<INavigationNode>;
+export interface INavNodeUpdateResult {
+    data: any;
+    node: INavigationNode;
+}
+/**
+ * Exposes the navigation components
+ *
+ */
+export declare class _Navigation extends _SharePointQueryable {
+    /**
+     * Gets the quicklaunch navigation nodes for the current context
+     *
+     */
+    get quicklaunch(): INavigationNodes;
+    /**
+     * Gets the top bar navigation nodes for the current context
+     *
+     */
+    get topNavigationBar(): INavigationNodes;
+}
+export interface INavigation {
+    readonly quicklaunch: INavigationNodes;
+    readonly topNavigationBar: INavigationNodes;
+}
+export declare const Navigation: import("../sharepointqueryable.js").ISPInvokableFactory<INavigation>;
+/**
+ * Represents the top level navigation service
+ */
+export declare class _NavigationService extends _SharePointQueryable {
+    constructor(path?: string);
+    /**
+     * The MenuState service operation returns a Menu-State (dump) of a SiteMapProvider on a site.
+     *
+     * @param menuNodeKey MenuNode.Key of the start node within the SiteMapProvider If no key is provided the SiteMapProvider.RootNode will be the root of the menu state.
+     * @param depth Depth of the dump. If no value is provided a dump with the depth of 10 is returned
+     * @param mapProviderName The name identifying the SiteMapProvider to be used
+     * @param customProperties comma seperated list of custom properties to be returned.
+     */
+    getMenuState(menuNodeKey?: string, depth?: number, mapProviderName?: string, customProperties?: string): Promise<IMenuNodeCollection>;
+    /**
+     * Tries to get a SiteMapNode.Key for a given URL within a site collection.
+     *
+     * @param currentUrl A url representing the SiteMapNode
+     * @param mapProviderName The name identifying the SiteMapProvider to be used
+     */
+    getMenuNodeKey(currentUrl: string, mapProviderName?: string): Promise<string>;
+}
+export interface INavigationService extends _NavigationService {
+}
+export declare const NavigationService: (path?: string) => INavigationService;
+export interface IMenuNode {
+    CustomProperties: any[];
+    FriendlyUrlSegment: string;
+    IsDeleted: boolean;
+    IsHidden: boolean;
+    Key: string;
+    Nodes: IMenuNode[];
+    NodeType: number;
+    SimpleUrl: string;
+    Title: string;
+}
+export interface IMenuNodeCollection {
+    FriendlyUrlPrefix: string;
+    Nodes: IMenuNode[];
+    SimpleUrl: string;
+    SPSitePrefix: string;
+    SPWebPrefix: string;
+    StartingNodeKey: string;
+    StartingNodeTitle: string;
+    Version: Date;
+}
+export interface ISerializableNavigationNode {
+    Id: number;
+    Title: string;
+    Url: string;
+    IsDocLib: boolean;
+    IsExternal: boolean;
+    ParentId: number;
+    ListTemplateType: number;
+    AudienceIds: string[];
+    Children: ISerializableNavigationNode[];
+}
+/**
+ * Result from adding a navigation node
+ *
+ */
+export interface INavigationNodeAddResult {
+    data: INavNodeInfo;
+    node: INavigationNode;
+}
+/**
+ * Represents the information describing a navigation node
+ */
+export interface INavNodeInfo {
+    AudienceIds: string[] | null;
+    Id: number;
+    IsDocLib: boolean;
+    IsExternal: boolean;
+    IsVisible: boolean;
+    ListTemplateType: number;
+    Title: string;
+    Url: string;
+}
 //# sourceMappingURL=types.d.ts.map