@zxncij2390/monorepo3 3.18.0

package/packages/sp/lists/web.ts

@@ -0,0 +1,68 @@
+import { addProp } from "@pnp/queryable";
+import { _Web, Web } from "../webs/types.js";
+import { Lists, ILists, IList, List } from "./types.js";
+import { odataUrlFrom } from "../utils/odata-url-from.js";
+import { ISPCollection, SPCollection } from "../spqueryable.js";
+import { encodePath } from "../utils/encode-path-str.js";
+
+declare module "../webs/types" {
+    interface _Web {
+        readonly lists: ILists;
+        readonly siteUserInfoList: IList;
+        readonly defaultDocumentLibrary: IList;
+        readonly customListTemplates: ISPCollection;
+        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: ISPCollection;
+
+        /**
+         * 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>;
+    }
+}
+
+addProp(_Web, "lists", Lists);
+addProp(_Web, "siteUserInfoList", List);
+addProp(_Web, "defaultDocumentLibrary", List);
+addProp(_Web, "customListTemplates", SPCollection, "getcustomlisttemplates");
+
+_Web.prototype.getList = function (this: _Web, listRelativeUrl: string): IList {
+    return List(this, `getList('${encodePath(listRelativeUrl)}')`);
+};
+
+_Web.prototype.getCatalog = async function (this: _Web, type: number): Promise<IList> {
+    const data = await Web(this, `getcatalog(${type})`).select("Id")();
+    return List([this, odataUrlFrom(data)]);
+};

package/packages/sp/navigation/index.ts

@@ -0,0 +1,35 @@
+import { SPFI } from "../fi.js";
+import { NavigationService, 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 "../fi" {
+    interface SPFI {
+        readonly navigation: INavigationService;
+    }
+}
+
+Reflect.defineProperty(SPFI.prototype, "navigation", {
+    configurable: true,
+    enumerable: true,
+    get: function (this: SPFI) {
+        return this.create(NavigationService);
+    },
+});

package/packages/sp/navigation/types.ts

@@ -0,0 +1,243 @@
+import {
+    _SPCollection,
+    spInvokableFactory,
+    deleteable,
+    _SPInstance,
+    _SPQueryable,
+    IDeleteable,
+    ISPQueryable,
+} from "../spqueryable.js";
+import { body } from "@pnp/queryable";
+import { defaultPath } from "../decorators.js";
+import { spPost, spPostMerge } from "../operations.js";
+import { extractWebUrl } from "../index.js";
+import { combine } from "@pnp/core";
+
+/**
+ * Represents a collection of navigation nodes
+ *
+ */
+export class _NavigationNodes extends _SPCollection<INavNodeInfo[]> {
+
+    /**
+     * Gets a navigation node by id
+     *
+     * @param id The id of the node
+     */
+    public getById(id: number): INavigationNode {
+        return NavigationNode(this).concat(`(${id})`);
+    }
+
+    /**
+     * 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)
+     */
+    public async add(title: string, url: string, visible = true): Promise<INavigationNodeAddResult> {
+
+        const postBody = body({
+            IsVisible: visible,
+            Title: title,
+            Url: url,
+        });
+
+        const data = await spPost(NavigationNodes(this, null), postBody);
+
+        return {
+            data,
+            node: this.getById(data.Id),
+        };
+    }
+
+    /**
+     * 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
+     */
+    public moveAfter(nodeId: number, previousNodeId: number): Promise<void> {
+
+        const postBody = body({
+            nodeId: nodeId,
+            previousNodeId: previousNodeId,
+        });
+
+        return spPost(NavigationNodes(this, "MoveAfter"), postBody);
+    }
+}
+export interface INavigationNodes extends _NavigationNodes {}
+export const NavigationNodes = spInvokableFactory<INavigationNodes>(_NavigationNodes);
+
+
+/**
+ * Represents an instance of a navigation node
+ *
+ */
+export class _NavigationNode extends _SPInstance<INavNodeInfo> {
+
+    public delete = deleteable();
+
+    /**
+     * Represents the child nodes of this node
+     */
+    public get children(): INavigationNodes {
+        return NavigationNodes(this, "children");
+    }
+
+    /**
+     * Updates this node
+     *
+     * @param properties Properties used to update this node
+     */
+    public async update(properties: Partial<INavNodeInfo>): Promise<INavNodeUpdateResult> {
+
+        const data = await spPostMerge(this, body(properties));
+
+        return {
+            data,
+            node: <any>this,
+        };
+    }
+}
+export interface INavigationNode extends _NavigationNode, IDeleteable { }
+export const NavigationNode = spInvokableFactory<INavigationNode>(_NavigationNode);
+
+export interface INavNodeUpdateResult {
+    data: any;
+    node: INavigationNode;
+}
+
+/**
+ * Exposes the navigation components
+ *
+ */
+@defaultPath("navigation")
+export class _Navigation extends _SPQueryable {
+
+    /**
+     * Gets the quicklaunch navigation nodes for the current context
+     *
+     */
+    public get quicklaunch(): INavigationNodes {
+        return NavigationNodes(this, "quicklaunch");
+    }
+
+    /**
+     * Gets the top bar navigation nodes for the current context
+     *
+     */
+    public get topNavigationBar(): INavigationNodes {
+        return NavigationNodes(this, "topnavigationbar");
+    }
+}
+export interface INavigation {
+    readonly quicklaunch: INavigationNodes;
+    readonly topNavigationBar: INavigationNodes;
+}
+export const Navigation: INavigation = <any>spInvokableFactory(_Navigation);
+
+/**
+ * Represents the top level navigation service
+ */
+export class _NavigationService extends _SPQueryable {
+
+    constructor(base: string | ISPQueryable = null, path?: string) {
+        super(base, path);
+
+        this._url = combine(extractWebUrl(this._url), "_api/navigation", path);
+    }
+
+    /**
+     * 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.
+     */
+    public getMenuState(menuNodeKey: string = null, depth = 10, mapProviderName: string = null, customProperties: string = null): Promise<IMenuNodeCollection> {
+
+        return spPost(NavigationService(this, "MenuState"), body({
+            customProperties,
+            depth,
+            mapProviderName,
+            menuNodeKey,
+        }));
+    }
+
+    /**
+     * 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
+     */
+    public getMenuNodeKey(currentUrl: string, mapProviderName: string = null): Promise<string> {
+
+        return spPost(NavigationService(this, "MenuNodeKey"), body({
+            currentUrl,
+            mapProviderName,
+        }));
+    }
+}
+export interface INavigationService extends _NavigationService {}
+export const NavigationService = (base?: string | ISPQueryable, path?: string) => <INavigationService>new _NavigationService(base, path);
+
+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;
+}

package/packages/sp/navigation/web.ts

@@ -0,0 +1,19 @@
+import { addProp } from "@pnp/queryable";
+import { _Web } from "../webs/types.js";
+import { Navigation, INavigation } from "./types.js";
+
+declare module "../webs/types" {
+    interface _Web {
+        navigation: INavigation;
+    }
+    interface IWeb {
+
+        /**
+         * Gets a navigation object that represents navigation on the Web site,
+         * including the Quick Launch area and the top navigation bar
+         */
+        navigation: INavigation;
+    }
+}
+
+addProp(_Web, "navigation", <any>Navigation);

package/packages/sp/operations.ts

@@ -0,0 +1,33 @@
+import { op, get, post, patch, del } from "@pnp/queryable";
+import { ISPQueryable } from "./spqueryable.js";
+
+export const spGet = <T = any>(o: ISPQueryable<any>, init?: RequestInit): Promise<T> => {
+    return op(o, get, init);
+};
+
+export const spPost = <T = any>(o: ISPQueryable<any>, init?: RequestInit): Promise<T> => op(o, post, init);
+
+export const spPostMerge = <T = any>(o: ISPQueryable<any>, init?: RequestInit): Promise<T> => {
+    init = init || {};
+    init.headers = { ...init.headers, "X-HTTP-Method": "MERGE" };
+
+    return spPost<T>(o, init);
+};
+
+export const spPostDelete = <T = any>(o: ISPQueryable<any>, init?: RequestInit): Promise<T> => {
+    init = init || {};
+    init.headers = { ...init.headers || {}, "X-HTTP-Method": "DELETE" };
+
+    return spPost<T>(o, init);
+};
+
+export const spPostDeleteETag = <T = any>(o: ISPQueryable<any>, init?: RequestInit, eTag = "*"): Promise<T> => {
+    init = init || {};
+    init.headers = { ...init.headers || {}, "IF-Match": eTag };
+
+    return spPostDelete<T>(o, init);
+};
+
+export const spDelete = <T = any>(o: ISPQueryable<any>, init?: RequestInit): Promise<T> => op(o, del, init);
+
+export const spPatch = <T = any>(o: ISPQueryable<any>, init?: RequestInit): Promise<T> => op(o, patch, init);

package/packages/sp/package.json

@@ -0,0 +1,15 @@
+{
+    "name": "@pnp/sp",
+    "version": "0.0.0-PLACEHOLDER",
+    "description": "pnp - provides a fluent api for working with SharePoint REST",
+    "main": "./index.js",
+    "typings": "./index",
+    "scripts": {
+        "postinstall": "node ./post-install.cjs"
+    },
+    "dependencies": {
+        "tslib": "2.4.1",
+        "@pnp/core": "0.0.0-PLACEHOLDER",
+        "@pnp/queryable": "0.0.0-PLACEHOLDER"
+    }
+}

package/packages/sp/post-install.cjs

@@ -0,0 +1,20 @@
+const { readFileSync } = require("fs");
+const { join } = require("path");
+const projectRoot = process.cwd();
+const packageLoc = join(projectRoot, "package.json");
+const packageFile = readFileSync(packageLoc, "utf8");
+const packageJSON = JSON.parse(packageFile);
+if (packageJSON.dependencies != null) {
+    const spfxVersion = packageJSON.dependencies["@microsoft/sp-core-library"];
+    if (spfxVersion != null) {
+        const spfxVersionFloat = parseFloat(spfxVersion);
+        if (spfxVersionFloat > 1.11 && spfxVersionFloat < 1.15) {
+            console.log("");
+            console.log("\x1b[43m%s\x1b[0m", " PnPjs WARNING ");
+            console.log("\x1b[33m%s\x1b[0m", "  The version of SPFx you are using requires an update to work with PnPjs. Please make sure to follow the getting started instructions to make the appropriate changes. ➡ https://pnp.github.io/pnpjs/getting-started/#spfx-version-1121-later");
+            console.log("");
+        }
+    }
+} else {
+    console.log("Package has no dependencies");
+}

package/packages/sp/presets/all.ts

@@ -0,0 +1,75 @@
+import "../appcatalog/index.js";
+import "../attachments/index.js";
+import "../clientside-pages/index.js";
+import "../column-defaults/index.js";
+import "../comments/index.js";
+import "../content-types/index.js";
+import "../favorites/index.js";
+import "../features/index.js";
+import "../fields/index.js";
+import "../files/index.js";
+import "../folders/index.js";
+import "../forms/index.js";
+import "../hubsites/index.js";
+import "../items/index.js";
+import "../lists/index.js";
+import "../navigation/index.js";
+import "../profiles/index.js";
+import "../publishing-sitepageservice/index.js";
+import "../regional-settings/index.js";
+import "../related-items/index.js";
+import "../search/index.js";
+import "../security/index.js";
+import "../sharing/index.js";
+import "../site-designs/index.js";
+import "../site-groups/index.js";
+import "../site-scripts/index.js";
+import "../site-users/index.js";
+import "../sites/index.js";
+import "../social/index.js";
+import "../sputilities/index.js";
+import "../subscriptions/index.js";
+import "../taxonomy/index.js";
+import "../user-custom-actions/index.js";
+import "../views/index.js";
+import "../webparts/index.js";
+import "../webs/index.js";
+
+export * from "../appcatalog/index.js";
+export * from "../attachments/index.js";
+export * from "../clientside-pages/index.js";
+export * from "../column-defaults/index.js";
+export * from "../comments/index.js";
+export * from "../content-types/index.js";
+export * from "../favorites/index.js";
+export * from "../features/index.js";
+export * from "../fields/index.js";
+export * from "../files/index.js";
+export * from "../folders/index.js";
+export * from "../forms/index.js";
+export * from "../hubsites/index.js";
+export * from "../items/index.js";
+export * from "../lists/index.js";
+export * from "../navigation/index.js";
+export * from "../utils/odata-url-from.js";
+export * from "../profiles/index.js";
+export * from "../publishing-sitepageservice/index.js";
+export * from "../regional-settings/index.js";
+export * from "../related-items/index.js";
+export * from "../search/index.js";
+export * from "../security/index.js";
+export * from "../sharing/index.js";
+export * from "../site-designs/index.js";
+export * from "../site-groups/index.js";
+export * from "../site-scripts/index.js";
+export * from "../site-users/index.js";
+export * from "../sites/index.js";
+export * from "../social/index.js";
+export * from "../sputilities/index.js";
+export * from "../subscriptions/index.js";
+export * from "../taxonomy/index.js";
+export * from "../user-custom-actions/index.js";
+export * from "../views/index.js";
+export * from "../webparts/index.js";
+export * from "../webs/index.js";
+export * from "../index.js";

package/packages/sp/profiles/index.ts

@@ -0,0 +1,30 @@
+import { SPFI } from "../fi.js";
+import { Profiles, IProfiles } from "./types.js";
+
+export {
+    IProfiles,
+    Profiles,
+    IClientPeoplePickerQueryParameters,
+    IFollowedContent,
+    IHashTag,
+    IHashTagCollection,
+    IPeoplePickerEntity,
+    IPeoplePickerEntityData,
+    IPeoplePickerQuerySettings,
+    IUserProfile,
+    UrlZone,
+} from "./types.js";
+
+declare module "../fi" {
+    interface SPFI {
+        readonly profiles: IProfiles;
+    }
+}
+
+Reflect.defineProperty(SPFI.prototype, "profiles", {
+    configurable: true,
+    enumerable: true,
+    get: function (this: SPFI) {
+        return this.create(Profiles);
+    },
+});