@pnp/sp 2.8.0 → 2.12.0

package/sputilities/types.d.ts

@@ -1,131 +1,131 @@
-import { _SharePointQueryable, ISharePointQueryable } from "../sharepointqueryable.js";
-import { ITypedHash } from "@pnp/common";
-import { SPBatch } from "../batch.js";
-import { ICachingOptions, IQueryable } from "@pnp/odata";
-import { IPrincipalInfo, PrincipalType, PrincipalSource } from "../types.js";
-import { IFile } from "../files/types.js";
-export declare class _Utilities extends _SharePointQueryable implements IUtilities {
-    constructor(baseUrl: string | ISharePointQueryable, methodName: string);
-    excute<T>(props: any): Promise<T>;
-    sendEmail(props: IEmailProperties): Promise<void>;
-    getCurrentUserEmailAddresses(): Promise<string>;
-    resolvePrincipal(input: string, scopes: PrincipalType, sources: PrincipalSource, inputIsEmailOnly: boolean, addToUserInfoList: boolean, matchUserInfoList?: boolean): Promise<IPrincipalInfo>;
-    searchPrincipals(input: string, scopes: PrincipalType, sources: PrincipalSource, groupName: string, maxCount: number): Promise<IPrincipalInfo[]>;
-    createEmailBodyForInvitation(pageAddress: string): Promise<string>;
-    expandGroupsToPrincipals(inputs: string[], maxCount?: number): Promise<IPrincipalInfo[]>;
-    createWikiPage(info: IWikiPageCreationInfo): Promise<ICreateWikiPageResult>;
-}
-/**
- * Describes the SharePoint utility methods
- */
-export interface IUtilities {
-    /**
-     * Gives you the ability to cache returned data in an easy way.
-     * @param options instance of ICachingOptions
-     */
-    usingCaching(options?: ICachingOptions): this;
-    /**
-     * Gives you the ability to batch multiple requests into a single request to SharePoint.
-     * @param batch instance of SPBatch
-     */
-    inBatch(batch: SPBatch): this;
-    /**
-     * This methods will send an e-mail based on the incoming properties of the IEmailProperties parameter.
-     * @param props IEmailProperties object
-     */
-    sendEmail(props: IEmailProperties): Promise<void>;
-    /**
-     * This method returns the current user's email addresses known to SharePoint.
-     */
-    getCurrentUserEmailAddresses(): Promise<string>;
-    /**
-     * Gets information about a principal that matches the specified Search criteria.
-     * @param email E-mail address
-     * @param scopes Specifies the type to be used when searching for a principal
-     * @param sources Specifies the source to be used when searching for a principal.
-     * @param inputIsEmailOnly Specifies whether only the e-mail address will be used when searching for a principal.
-     * @param addToUserInfoList Specifies whether the user should be added to the hidden user info list.
-     * @param matchUserInfoList [Optional] By default false
-     */
-    resolvePrincipal(email: string, scopes: PrincipalType, sources: PrincipalSource, inputIsEmailOnly: boolean, addToUserInfoList: boolean, matchUserInfoList?: boolean): Promise<IPrincipalInfo>;
-    /**
-    * Gets information about the principals that match the specified search criteria.
-    * @param input Specifies the value to be used when searching for a principal.
-    * @param scopes Specifies the type to be used when searching for a principal.
-    * @param sources Specifies the source to be used when searching for a principal.
-    * @param groupName Specifies the collection of users to be used when searching for a principal.
-    * @param maxCount Specifies the maximum number of principals to be returned in the list.
-    */
-    searchPrincipals(input: string, scopes: PrincipalType, sources: PrincipalSource, groupName: string, maxCount: number): Promise<IPrincipalInfo[]>;
-    /**
-     * Gets the external (outside the firewall) URL to a document or resource in a site.
-     * @param pageAddress Specifies the URI for the document or resource. It must be a URL.
-     */
-    createEmailBodyForInvitation(pageAddress: string): Promise<string>;
-    /**
-     * Resolves the principals contained within the supplied groups.
-     * @param inputs A collection of groups to be expanded.
-     * @param maxCount Specifies the maximum number of principals to be returned.
-     */
-    expandGroupsToPrincipals(inputs: string[], maxCount?: number): Promise<IPrincipalInfo[]>;
-    /**
-     * Creates a new Wiki page.
-     * @param info Instance of IWikiPageCreationInfo.
-     */
-    createWikiPage(info: IWikiPageCreationInfo): Promise<ICreateWikiPageResult>;
-}
-export declare const Utilities: import("../sharepointqueryable.js").ISPInvokableFactory<IUtilities & Pick<IQueryable<any>, "configure" | "setRuntime" | "getRuntime">>;
-export interface ICreateWikiPageResult {
-    /**
-     * The returned Wiki page represented by raw data.
-     */
-    data: any;
-    /**
-     * The returned Wiki page represented as a file which can be further updated.
-     */
-    file: IFile;
-}
-export interface IEmailProperties {
-    /**
-     * The list of receivers represented by a string array.
-     */
-    To: string[];
-    /**
-     * The list of receivers as CC (carbon copy) represented by a string array.
-     * This is optional.
-     */
-    CC?: string[];
-    /**
-     * The list of receivers as BCC (blind carbon copy) represented by a string array.
-     * This is optional.
-     */
-    BCC?: string[];
-    /**
-     * The subject of the email.
-     */
-    Subject: string;
-    /**
-     * The body of the email.
-     */
-    Body: string;
-    /**
-     * The additional headers appened to the request in key/value pairs.
-     */
-    AdditionalHeaders?: ITypedHash<string>;
-    /**
-     * The from address of the email.
-     * This is optional.
-     */
-    From?: string;
-}
-export interface IWikiPageCreationInfo {
-    /**
-     * The server-relative-url of the wiki page to be created.
-     */
-    ServerRelativeUrl: string;
-    /**
-     * The wiki content to be set in the wiki page.
-     */
-    WikiHtmlContent: string;
-}
+import { _SharePointQueryable, ISharePointQueryable } from "../sharepointqueryable.js";
+import { ITypedHash } from "@pnp/common";
+import { SPBatch } from "../batch.js";
+import { ICachingOptions, IQueryable } from "@pnp/odata";
+import { IPrincipalInfo, PrincipalType, PrincipalSource } from "../types.js";
+import { IFile } from "../files/types.js";
+export declare class _Utilities extends _SharePointQueryable implements IUtilities {
+    constructor(baseUrl: string | ISharePointQueryable, methodName: string);
+    excute<T>(props: any): Promise<T>;
+    sendEmail(props: IEmailProperties): Promise<void>;
+    getCurrentUserEmailAddresses(): Promise<string>;
+    resolvePrincipal(input: string, scopes: PrincipalType, sources: PrincipalSource, inputIsEmailOnly: boolean, addToUserInfoList: boolean, matchUserInfoList?: boolean): Promise<IPrincipalInfo>;
+    searchPrincipals(input: string, scopes: PrincipalType, sources: PrincipalSource, groupName: string, maxCount: number): Promise<IPrincipalInfo[]>;
+    createEmailBodyForInvitation(pageAddress: string): Promise<string>;
+    expandGroupsToPrincipals(inputs: string[], maxCount?: number): Promise<IPrincipalInfo[]>;
+    createWikiPage(info: IWikiPageCreationInfo): Promise<ICreateWikiPageResult>;
+}
+/**
+ * Describes the SharePoint utility methods
+ */
+export interface IUtilities {
+    /**
+     * Gives you the ability to cache returned data in an easy way.
+     * @param options instance of ICachingOptions
+     */
+    usingCaching(options?: ICachingOptions): this;
+    /**
+     * Gives you the ability to batch multiple requests into a single request to SharePoint.
+     * @param batch instance of SPBatch
+     */
+    inBatch(batch: SPBatch): this;
+    /**
+     * This methods will send an e-mail based on the incoming properties of the IEmailProperties parameter.
+     * @param props IEmailProperties object
+     */
+    sendEmail(props: IEmailProperties): Promise<void>;
+    /**
+     * This method returns the current user's email addresses known to SharePoint.
+     */
+    getCurrentUserEmailAddresses(): Promise<string>;
+    /**
+     * Gets information about a principal that matches the specified Search criteria.
+     * @param email E-mail address
+     * @param scopes Specifies the type to be used when searching for a principal
+     * @param sources Specifies the source to be used when searching for a principal.
+     * @param inputIsEmailOnly Specifies whether only the e-mail address will be used when searching for a principal.
+     * @param addToUserInfoList Specifies whether the user should be added to the hidden user info list.
+     * @param matchUserInfoList [Optional] By default false
+     */
+    resolvePrincipal(email: string, scopes: PrincipalType, sources: PrincipalSource, inputIsEmailOnly: boolean, addToUserInfoList: boolean, matchUserInfoList?: boolean): Promise<IPrincipalInfo>;
+    /**
+    * Gets information about the principals that match the specified search criteria.
+    * @param input Specifies the value to be used when searching for a principal.
+    * @param scopes Specifies the type to be used when searching for a principal.
+    * @param sources Specifies the source to be used when searching for a principal.
+    * @param groupName Specifies the collection of users to be used when searching for a principal.
+    * @param maxCount Specifies the maximum number of principals to be returned in the list.
+    */
+    searchPrincipals(input: string, scopes: PrincipalType, sources: PrincipalSource, groupName: string, maxCount: number): Promise<IPrincipalInfo[]>;
+    /**
+     * Gets the external (outside the firewall) URL to a document or resource in a site.
+     * @param pageAddress Specifies the URI for the document or resource. It must be a URL.
+     */
+    createEmailBodyForInvitation(pageAddress: string): Promise<string>;
+    /**
+     * Resolves the principals contained within the supplied groups.
+     * @param inputs A collection of groups to be expanded.
+     * @param maxCount Specifies the maximum number of principals to be returned.
+     */
+    expandGroupsToPrincipals(inputs: string[], maxCount?: number): Promise<IPrincipalInfo[]>;
+    /**
+     * Creates a new Wiki page.
+     * @param info Instance of IWikiPageCreationInfo.
+     */
+    createWikiPage(info: IWikiPageCreationInfo): Promise<ICreateWikiPageResult>;
+}
+export declare const Utilities: import("../sharepointqueryable.js").ISPInvokableFactory<IUtilities & Pick<IQueryable<any>, "configure" | "setRuntime" | "getRuntime">>;
+export interface ICreateWikiPageResult {
+    /**
+     * The returned Wiki page represented by raw data.
+     */
+    data: any;
+    /**
+     * The returned Wiki page represented as a file which can be further updated.
+     */
+    file: IFile;
+}
+export interface IEmailProperties {
+    /**
+     * The list of receivers represented by a string array.
+     */
+    To: string[];
+    /**
+     * The list of receivers as CC (carbon copy) represented by a string array.
+     * This is optional.
+     */
+    CC?: string[];
+    /**
+     * The list of receivers as BCC (blind carbon copy) represented by a string array.
+     * This is optional.
+     */
+    BCC?: string[];
+    /**
+     * The subject of the email.
+     */
+    Subject: string;
+    /**
+     * The body of the email.
+     */
+    Body: string;
+    /**
+     * The additional headers appened to the request in key/value pairs.
+     */
+    AdditionalHeaders?: ITypedHash<string>;
+    /**
+     * The from address of the email.
+     * This is optional.
+     */
+    From?: string;
+}
+export interface IWikiPageCreationInfo {
+    /**
+     * The server-relative-url of the wiki page to be created.
+     */
+    ServerRelativeUrl: string;
+    /**
+     * The wiki content to be set in the wiki page.
+     */
+    WikiHtmlContent: string;
+}
 //# sourceMappingURL=types.d.ts.map

package/sputilities/types.js

@@ -1,119 +1,119 @@
-import { __awaiter, __extends, __generator } from "tslib";
-import { _SharePointQueryable, spInvokableFactory } from "../sharepointqueryable.js";
-import { assign } from "@pnp/common";
-import { body } from "@pnp/odata";
-import { odataUrlFrom } from "../odata.js";
-import { metadata } from "../utils/metadata.js";
-import { File } from "../files/types.js";
-import { extractWebUrl } from "../utils/extractweburl.js";
-import { spPost } from "../operations.js";
-import { tag } from "../telemetry.js";
-import { objectToSPKeyValueCollection } from "../utils/objectToSPKeyValueCollection.js";
-var _Utilities = /** @class */ (function (_super) {
-    __extends(_Utilities, _super);
-    function _Utilities(baseUrl, methodName) {
-        var _this = this;
-        var url = typeof baseUrl === "string" ? baseUrl : baseUrl.toUrl();
-        _this = _super.call(this, extractWebUrl(url), "_api/SP.Utilities.Utility." + methodName) || this;
-        return _this;
-    }
-    _Utilities.prototype.excute = function (props) {
-        return spPost(this, body(props));
-    };
-    _Utilities.prototype.sendEmail = function (props) {
-        var params = {
-            properties: assign(metadata("SP.Utilities.EmailProperties"), {
-                Body: props.Body,
-                From: props.From,
-                Subject: props.Subject,
-            }),
-        };
-        if (props.To && props.To.length > 0) {
-            params.properties = assign(params.properties, {
-                To: { results: props.To },
-            });
-        }
-        if (props.CC && props.CC.length > 0) {
-            params.properties = assign(params.properties, {
-                CC: { results: props.CC },
-            });
-        }
-        if (props.BCC && props.BCC.length > 0) {
-            params.properties = assign(params.properties, {
-                BCC: { results: props.BCC },
-            });
-        }
-        if (props.AdditionalHeaders) {
-            params.properties = assign(params.properties, {
-                AdditionalHeaders: objectToSPKeyValueCollection(props.AdditionalHeaders),
-            });
-        }
-        return tag.configure(this.clone(UtilitiesCloneFactory, "SendEmail", true), "u.sendEmail").excute(params);
-    };
-    _Utilities.prototype.getCurrentUserEmailAddresses = function () {
-        return tag.configure(this.clone(UtilitiesCloneFactory, "GetCurrentUserEmailAddresses", true), "u.getCurrentUserEmailAddresses").excute({});
-    };
-    _Utilities.prototype.resolvePrincipal = function (input, scopes, sources, inputIsEmailOnly, addToUserInfoList, matchUserInfoList) {
-        if (matchUserInfoList === void 0) { matchUserInfoList = false; }
-        var params = {
-            addToUserInfoList: addToUserInfoList,
-            input: input,
-            inputIsEmailOnly: inputIsEmailOnly,
-            matchUserInfoList: matchUserInfoList,
-            scopes: scopes,
-            sources: sources,
-        };
-        var clone = this.clone(UtilitiesCloneFactory, "ResolvePrincipalInCurrentContext", true);
-        return tag.configure(clone, "u.ResolvePrincipalInCurrentContext").excute(params);
-    };
-    _Utilities.prototype.searchPrincipals = function (input, scopes, sources, groupName, maxCount) {
-        var params = {
-            groupName: groupName,
-            input: input,
-            maxCount: maxCount,
-            scopes: scopes,
-            sources: sources,
-        };
-        var clone = this.clone(UtilitiesCloneFactory, "SearchPrincipalsUsingContextWeb", true);
-        return tag.configure(clone, "u.SearchPrincipalsUsingContextWeb").excute(params);
-    };
-    _Utilities.prototype.createEmailBodyForInvitation = function (pageAddress) {
-        var params = {
-            pageAddress: pageAddress,
-        };
-        var clone = this.clone(UtilitiesCloneFactory, "CreateEmailBodyForInvitation", true);
-        return tag.configure(clone, "u.CreateEmailBodyForInvitation").excute(params);
-    };
-    _Utilities.prototype.expandGroupsToPrincipals = function (inputs, maxCount) {
-        if (maxCount === void 0) { maxCount = 30; }
-        var params = {
-            inputs: inputs,
-            maxCount: maxCount,
-        };
-        var clone = this.clone(UtilitiesCloneFactory, "ExpandGroupsToPrincipals", true);
-        return tag.configure(clone, "u.ExpandGroupsToPrincipals").excute(params);
-    };
-    _Utilities.prototype.createWikiPage = function (info) {
-        return __awaiter(this, void 0, void 0, function () {
-            var clone, newPage;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        clone = this.clone(UtilitiesCloneFactory, "CreateWikiPageInContextWeb", true);
-                        return [4 /*yield*/, tag.configure(clone, "u.CreateWikiPageInContextWeb").excute({ parameters: info })];
-                    case 1:
-                        newPage = _a.sent();
-                        return [2 /*return*/, {
-                                data: newPage,
-                                file: File(odataUrlFrom(newPage)),
-                            }];
-                }
-            });
-        });
-    };
-    return _Utilities;
-}(_SharePointQueryable));
-export { _Utilities };
-export var Utilities = spInvokableFactory(_Utilities);
-var UtilitiesCloneFactory = function (baseUrl, path) { return Utilities(baseUrl, path); };
+import { __awaiter, __extends, __generator } from "tslib";
+import { _SharePointQueryable, spInvokableFactory } from "../sharepointqueryable.js";
+import { assign } from "@pnp/common";
+import { body } from "@pnp/odata";
+import { odataUrlFrom } from "../odata.js";
+import { metadata } from "../utils/metadata.js";
+import { File } from "../files/types.js";
+import { extractWebUrl } from "../utils/extractweburl.js";
+import { spPost } from "../operations.js";
+import { tag } from "../telemetry.js";
+import { objectToSPKeyValueCollection } from "../utils/objectToSPKeyValueCollection.js";
+var _Utilities = /** @class */ (function (_super) {
+    __extends(_Utilities, _super);
+    function _Utilities(baseUrl, methodName) {
+        var _this = this;
+        var url = typeof baseUrl === "string" ? baseUrl : baseUrl.toUrl();
+        _this = _super.call(this, extractWebUrl(url), "_api/SP.Utilities.Utility." + methodName) || this;
+        return _this;
+    }
+    _Utilities.prototype.excute = function (props) {
+        return spPost(this, body(props));
+    };
+    _Utilities.prototype.sendEmail = function (props) {
+        var params = {
+            properties: assign(metadata("SP.Utilities.EmailProperties"), {
+                Body: props.Body,
+                From: props.From,
+                Subject: props.Subject,
+            }),
+        };
+        if (props.To && props.To.length > 0) {
+            params.properties = assign(params.properties, {
+                To: { results: props.To },
+            });
+        }
+        if (props.CC && props.CC.length > 0) {
+            params.properties = assign(params.properties, {
+                CC: { results: props.CC },
+            });
+        }
+        if (props.BCC && props.BCC.length > 0) {
+            params.properties = assign(params.properties, {
+                BCC: { results: props.BCC },
+            });
+        }
+        if (props.AdditionalHeaders) {
+            params.properties = assign(params.properties, {
+                AdditionalHeaders: objectToSPKeyValueCollection(props.AdditionalHeaders),
+            });
+        }
+        return tag.configure(this.clone(UtilitiesCloneFactory, "SendEmail", true), "u.sendEmail").excute(params);
+    };
+    _Utilities.prototype.getCurrentUserEmailAddresses = function () {
+        return tag.configure(this.clone(UtilitiesCloneFactory, "GetCurrentUserEmailAddresses", true), "u.getCurrentUserEmailAddresses").excute({});
+    };
+    _Utilities.prototype.resolvePrincipal = function (input, scopes, sources, inputIsEmailOnly, addToUserInfoList, matchUserInfoList) {
+        if (matchUserInfoList === void 0) { matchUserInfoList = false; }
+        var params = {
+            addToUserInfoList: addToUserInfoList,
+            input: input,
+            inputIsEmailOnly: inputIsEmailOnly,
+            matchUserInfoList: matchUserInfoList,
+            scopes: scopes,
+            sources: sources,
+        };
+        var clone = this.clone(UtilitiesCloneFactory, "ResolvePrincipalInCurrentContext", true);
+        return tag.configure(clone, "u.ResolvePrincipalInCurrentContext").excute(params);
+    };
+    _Utilities.prototype.searchPrincipals = function (input, scopes, sources, groupName, maxCount) {
+        var params = {
+            groupName: groupName,
+            input: input,
+            maxCount: maxCount,
+            scopes: scopes,
+            sources: sources,
+        };
+        var clone = this.clone(UtilitiesCloneFactory, "SearchPrincipalsUsingContextWeb", true);
+        return tag.configure(clone, "u.SearchPrincipalsUsingContextWeb").excute(params);
+    };
+    _Utilities.prototype.createEmailBodyForInvitation = function (pageAddress) {
+        var params = {
+            pageAddress: pageAddress,
+        };
+        var clone = this.clone(UtilitiesCloneFactory, "CreateEmailBodyForInvitation", true);
+        return tag.configure(clone, "u.CreateEmailBodyForInvitation").excute(params);
+    };
+    _Utilities.prototype.expandGroupsToPrincipals = function (inputs, maxCount) {
+        if (maxCount === void 0) { maxCount = 30; }
+        var params = {
+            inputs: inputs,
+            maxCount: maxCount,
+        };
+        var clone = this.clone(UtilitiesCloneFactory, "ExpandGroupsToPrincipals", true);
+        return tag.configure(clone, "u.ExpandGroupsToPrincipals").excute(params);
+    };
+    _Utilities.prototype.createWikiPage = function (info) {
+        return __awaiter(this, void 0, void 0, function () {
+            var clone, newPage;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        clone = this.clone(UtilitiesCloneFactory, "CreateWikiPageInContextWeb", true);
+                        return [4 /*yield*/, tag.configure(clone, "u.CreateWikiPageInContextWeb").excute({ parameters: info })];
+                    case 1:
+                        newPage = _a.sent();
+                        return [2 /*return*/, {
+                                data: newPage,
+                                file: File(odataUrlFrom(newPage)),
+                            }];
+                }
+            });
+        });
+    };
+    return _Utilities;
+}(_SharePointQueryable));
+export { _Utilities };
+export var Utilities = spInvokableFactory(_Utilities);
+var UtilitiesCloneFactory = function (baseUrl, path) { return Utilities(baseUrl, path); };
 //# sourceMappingURL=types.js.map

package/subscriptions/index.d.ts

@@ -1,3 +1,3 @@
-import "./list.js";
-export { ISubscription, ISubscriptionAddResult, ISubscriptionUpdateResult, ISubscriptions, Subscription, Subscriptions, } from "./types.js";
+import "./list.js";
+export { ISubscription, ISubscriptionAddResult, ISubscriptionUpdateResult, ISubscriptions, Subscription, Subscriptions, } from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/subscriptions/index.js

@@ -1,3 +1,3 @@
-import "./list.js";
-export { Subscription, Subscriptions, } from "./types.js";
+import "./list.js";
+export { Subscription, Subscriptions, } from "./types.js";
 //# sourceMappingURL=index.js.map

package/subscriptions/list.d.ts

@@ -1,14 +1,14 @@
-import { ISubscriptions } from "./types.js";
-declare module "../lists/types" {
-    interface _List {
-        readonly subscriptions: ISubscriptions;
-    }
-    interface IList {
-        /**
-         * Gets the collection of webhooks created for this list
-         *
-         */
-        readonly subscriptions: ISubscriptions;
-    }
-}
+import { ISubscriptions } from "./types.js";
+declare module "../lists/types" {
+    interface _List {
+        readonly subscriptions: ISubscriptions;
+    }
+    interface IList {
+        /**
+         * Gets the collection of webhooks created for this list
+         *
+         */
+        readonly subscriptions: ISubscriptions;
+    }
+}
 //# sourceMappingURL=list.d.ts.map

package/subscriptions/list.js

@@ -1,5 +1,5 @@
-import { addProp } from "@pnp/odata";
-import { _List } from "../lists/types.js";
-import { Subscriptions } from "./types.js";
-addProp(_List, "subscriptions", Subscriptions);
+import { addProp } from "@pnp/odata";
+import { _List } from "../lists/types.js";
+import { Subscriptions } from "./types.js";
+addProp(_List, "subscriptions", Subscriptions);
 //# sourceMappingURL=list.js.map