@pnp/sp 2.8.0 → 2.12.0

package/LICENSE

@@ -1,25 +1,25 @@
-SharePoint Patterns and Practices (PnP)
-
-The MIT License (MIT)
-
-Copyright (c) Microsoft Corporation
-
-All rights reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SharePoint Patterns and Practices (PnP)
+
+The MIT License (MIT)
+
+Copyright (c) Microsoft Corporation
+
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/appcatalog/index.d.ts

@@ -1,9 +1,9 @@
-import { IWeb } from "../webs/types.js";
-import "./web.js";
-export { IAppAddResult, IApp, IAppCatalog, App, AppCatalog, } from "./types.js";
-declare module "../rest" {
-    interface SPRest {
-        getTenantAppCatalogWeb(): Promise<IWeb>;
-    }
-}
+import { IWeb } from "../webs/types.js";
+import "./web.js";
+export { IAppAddResult, IApp, IAppCatalog, App, AppCatalog, } from "./types.js";
+declare module "../rest" {
+    interface SPRest {
+        getTenantAppCatalogWeb(): Promise<IWeb>;
+    }
+}
 //# sourceMappingURL=index.d.ts.map

package/appcatalog/index.js

@@ -1,31 +1,31 @@
-import { __awaiter, __generator } from "tslib";
-import { SPRest } from "../rest.js";
-import { Web } from "../webs/types.js";
-import "./web.js";
-import { SharePointQueryable } from "../sharepointqueryable.js";
-export { App, AppCatalog, } from "./types.js";
-SPRest.prototype.getTenantAppCatalogWeb = function () {
-    return __awaiter(this, void 0, void 0, function () {
-        var _this = this;
-        return __generator(this, function (_a) {
-            return [2 /*return*/, this.childConfigHook(function (_a) {
-                    var options = _a.options, runtime = _a.runtime;
-                    return __awaiter(_this, void 0, void 0, function () {
-                        var data;
-                        return __generator(this, function (_b) {
-                            switch (_b.label) {
-                                case 0: return [4 /*yield*/, SharePointQueryable("/", "_api/SP_TenantSettings_Current").configure(options).setRuntime(runtime)()];
-                                case 1:
-                                    data = _b.sent();
-                                    if (!(data === null || data === void 0 ? void 0 : data.CorporateCatalogUrl)) {
-                                        throw new Error("Failed to get tenant corporate app catalog, its not configured on the tenant.");
-                                    }
-                                    return [2 /*return*/, Web(data.CorporateCatalogUrl).configure(options).setRuntime(runtime)];
-                            }
-                        });
-                    });
-                })];
-        });
-    });
-};
+import { __awaiter, __generator } from "tslib";
+import { SPRest } from "../rest.js";
+import { Web } from "../webs/types.js";
+import "./web.js";
+import { SharePointQueryable } from "../sharepointqueryable.js";
+export { App, AppCatalog, } from "./types.js";
+SPRest.prototype.getTenantAppCatalogWeb = function () {
+    return __awaiter(this, void 0, void 0, function () {
+        var _this = this;
+        return __generator(this, function (_a) {
+            return [2 /*return*/, this.childConfigHook(function (_a) {
+                    var options = _a.options, runtime = _a.runtime;
+                    return __awaiter(_this, void 0, void 0, function () {
+                        var data;
+                        return __generator(this, function (_b) {
+                            switch (_b.label) {
+                                case 0: return [4 /*yield*/, SharePointQueryable("/", "_api/SP_TenantSettings_Current").configure(options).setRuntime(runtime)()];
+                                case 1:
+                                    data = _b.sent();
+                                    if (!(data === null || data === void 0 ? void 0 : data.CorporateCatalogUrl)) {
+                                        throw new Error("Failed to get tenant corporate app catalog, its not configured on the tenant.");
+                                    }
+                                    return [2 /*return*/, Web(data.CorporateCatalogUrl).configure(options).setRuntime(runtime)];
+                            }
+                        });
+                    });
+                })];
+        });
+    });
+};
 //# sourceMappingURL=index.js.map

package/appcatalog/types.d.ts

@@ -1,82 +1,82 @@
-import { ISharePointQueryable, _SharePointQueryableInstance, _SharePointQueryableCollection } from "../sharepointqueryable";
-import { IFile } from "../files/types.js";
-import "../items/index.js";
-export declare type AppCatalogScope = "tenant" | "sitecollection";
-export declare class _AppCatalog extends _SharePointQueryableCollection {
-    private readonly catalogPath;
-    constructor(baseUrl: string | ISharePointQueryable, path?: string);
-    /**
-     * Get details of specific app from the app catalog
-     * @param id - Specify the guid of the app
-     */
-    getAppById(id: string): IApp;
-    /**
-     * Synchronize a solution to the Microsoft Teams App Catalog
-     * @param id - Specify the guid of the app
-     * @param useSharePointItemId (optional) - By default this REST call requires the SP Item id of the app, not the app id.
-     *                            PnPjs will try to fetch the item id by default, you can still use this parameter to pass your own item id in the first parameter
-     */
-    syncSolutionToTeams(id: string | number, useSharePointItemId?: boolean): Promise<void>;
-    /**
-     * Uploads an app package. Not supported for batching
-     *
-     * @param filename Filename to create.
-     * @param content app package data (eg: the .app or .sppkg file).
-     * @param shouldOverWrite Should an app with the same name in the same location be overwritten? (default: true)
-     * @returns Promise<IAppAddResult>
-     */
-    add(filename: string, content: string | ArrayBuffer | Blob, shouldOverWrite?: boolean): Promise<IAppAddResult>;
-}
-export interface IAppCatalog extends _AppCatalog {
-}
-export declare const AppCatalog: import("../sharepointqueryable").ISPInvokableFactory<IAppCatalog>;
-export declare class _App extends _SharePointQueryableInstance {
-    /**
-     * This method deploys an app on the app catalog. It must be called in the context
-     * of the tenant app catalog web or it will fail.
-     *
-     * @param skipFeatureDeployment Deploy the app to the entire tenant
-     */
-    deploy(skipFeatureDeployment?: boolean): Promise<void>;
-    /**
-     * This method retracts a deployed app on the app catalog. It must be called in the context
-     * of the tenant app catalog web or it will fail.
-     */
-    retract(): Promise<void>;
-    /**
-     * This method allows an app which is already deployed to be installed on a web
-     */
-    install(): Promise<void>;
-    /**
-     * This method allows an app which is already installed to be uninstalled on a web
-     * Note: when you use the REST API to uninstall a solution package from the site, it is not relocated to the recycle bin
-     */
-    uninstall(): Promise<void>;
-    /**
-     * This method allows an app which is already installed to be upgraded on a web
-     */
-    upgrade(): Promise<void>;
-    /**
-     * This method removes an app from the app catalog. It must be called in the context
-     * of the tenant app catalog web or it will fail.
-     */
-    remove(): Promise<void>;
-    private do;
-}
-export interface IApp extends _App {
-}
-export declare const App: import("../sharepointqueryable").ISPInvokableFactory<IApp>;
-/**
- * Result object after adding an app
- */
-export interface IAppAddResult {
-    /**
-     * Contains metadata of the added app
-     */
-    data: any;
-    /**
-     * A File instance to the item in SharePoint
-     */
-    file: IFile;
-}
+import { ISharePointQueryable, _SharePointQueryableInstance, _SharePointQueryableCollection } from "../sharepointqueryable.js";
+import { IFile } from "../files/types.js";
+import "../items/index.js";
+export declare type AppCatalogScope = "tenant" | "sitecollection";
+export declare class _AppCatalog extends _SharePointQueryableCollection {
+    private readonly catalogPath;
+    constructor(baseUrl: string | ISharePointQueryable, path?: string);
+    /**
+     * Get details of specific app from the app catalog
+     * @param id - Specify the guid of the app
+     */
+    getAppById(id: string): IApp;
+    /**
+     * Synchronize a solution to the Microsoft Teams App Catalog
+     * @param id - Specify the guid of the app
+     * @param useSharePointItemId (optional) - By default this REST call requires the SP Item id of the app, not the app id.
+     *                            PnPjs will try to fetch the item id by default, you can still use this parameter to pass your own item id in the first parameter
+     */
+    syncSolutionToTeams(id: string | number, useSharePointItemId?: boolean): Promise<void>;
+    /**
+     * Uploads an app package. Not supported for batching
+     *
+     * @param filename Filename to create.
+     * @param content app package data (eg: the .app or .sppkg file).
+     * @param shouldOverWrite Should an app with the same name in the same location be overwritten? (default: true)
+     * @returns Promise<IAppAddResult>
+     */
+    add(filename: string, content: string | ArrayBuffer | Blob, shouldOverWrite?: boolean): Promise<IAppAddResult>;
+}
+export interface IAppCatalog extends _AppCatalog {
+}
+export declare const AppCatalog: import("../sharepointqueryable.js").ISPInvokableFactory<IAppCatalog>;
+export declare class _App extends _SharePointQueryableInstance {
+    /**
+     * This method deploys an app on the app catalog. It must be called in the context
+     * of the tenant app catalog web or it will fail.
+     *
+     * @param skipFeatureDeployment Deploy the app to the entire tenant
+     */
+    deploy(skipFeatureDeployment?: boolean): Promise<void>;
+    /**
+     * This method retracts a deployed app on the app catalog. It must be called in the context
+     * of the tenant app catalog web or it will fail.
+     */
+    retract(): Promise<void>;
+    /**
+     * This method allows an app which is already deployed to be installed on a web
+     */
+    install(): Promise<void>;
+    /**
+     * This method allows an app which is already installed to be uninstalled on a web
+     * Note: when you use the REST API to uninstall a solution package from the site, it is not relocated to the recycle bin
+     */
+    uninstall(): Promise<void>;
+    /**
+     * This method allows an app which is already installed to be upgraded on a web
+     */
+    upgrade(): Promise<void>;
+    /**
+     * This method removes an app from the app catalog. It must be called in the context
+     * of the tenant app catalog web or it will fail.
+     */
+    remove(): Promise<void>;
+    private do;
+}
+export interface IApp extends _App {
+}
+export declare const App: import("../sharepointqueryable.js").ISPInvokableFactory<IApp>;
+/**
+ * Result object after adding an app
+ */
+export interface IAppAddResult {
+    /**
+     * Contains metadata of the added app
+     */
+    data: any;
+    /**
+     * A File instance to the item in SharePoint
+     */
+    file: IFile;
+}
 //# sourceMappingURL=types.d.ts.map

package/appcatalog/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/appcatalog/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,oBAAoB,EACpB,4BAA4B,EAC5B,8BAA8B,EAEjC,MAAM,wBAAwB,CAAC;AAIhC,OAAO,EAAQ,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAGhD,OAAO,mBAAmB,CAAC;AAE3B,oBAAY,eAAe,GAAG,QAAQ,GAAG,gBAAgB,CAAC;AAE1D,qBAAa,WAAY,SAAQ,8BAA8B;IAE3D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;gBAEzB,OAAO,EAAE,MAAM,GAAG,oBAAoB,EAAE,IAAI,CAAC,EAAE,MAAM;IASjE;;;OAGG;IACI,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAInC;;;;;OAKG;IACU,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,mBAAmB,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BjG;;;;;;;OAOG;IACU,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,EAAE,eAAe,UAAO,GAAG,OAAO,CAAC,aAAa,CAAC;CAgB3H;AACD,MAAM,WAAW,WAAY,SAAQ,WAAW;CAAI;AACpD,eAAO,MAAM,UAAU,mEAA+C,CAAC;AAEvE,qBAAa,IAAK,SAAQ,4BAA4B;IAElD;;;;;OAKG;IAEI,MAAM,CAAC,qBAAqB,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3D;;;OAGG;IAEI,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B;;OAEG;IAEI,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B;;;OAGG;IAEI,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAIjC;;OAEG;IAEI,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B;;;OAGG;IAEI,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B,OAAO,CAAC,EAAE;CAGb;AACD,MAAM,WAAW,IAAK,SAAQ,IAAI;CAAI;AACtC,eAAO,MAAM,GAAG,4DAAiC,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,IAAI,EAAE,GAAG,CAAC;IACV;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;CACf"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/appcatalog/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,oBAAoB,EACpB,4BAA4B,EAC5B,8BAA8B,EAEjC,MAAM,2BAA2B,CAAC;AAInC,OAAO,EAAQ,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAGhD,OAAO,mBAAmB,CAAC;AAE3B,oBAAY,eAAe,GAAG,QAAQ,GAAG,gBAAgB,CAAC;AAE1D,qBAAa,WAAY,SAAQ,8BAA8B;IAE3D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;gBAEzB,OAAO,EAAE,MAAM,GAAG,oBAAoB,EAAE,IAAI,CAAC,EAAE,MAAM;IASjE;;;OAGG;IACI,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAInC;;;;;OAKG;IACU,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,mBAAmB,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BjG;;;;;;;OAOG;IACU,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,EAAE,eAAe,UAAO,GAAG,OAAO,CAAC,aAAa,CAAC;CAgB3H;AACD,MAAM,WAAW,WAAY,SAAQ,WAAW;CAAI;AACpD,eAAO,MAAM,UAAU,sEAA+C,CAAC;AAEvE,qBAAa,IAAK,SAAQ,4BAA4B;IAElD;;;;;OAKG;IAEI,MAAM,CAAC,qBAAqB,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3D;;;OAGG;IAEI,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B;;OAEG;IAEI,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B;;;OAGG;IAEI,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAIjC;;OAEG;IAEI,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B;;;OAGG;IAEI,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B,OAAO,CAAC,EAAE;CAGb;AACD,MAAM,WAAW,IAAK,SAAQ,IAAI;CAAI;AACtC,eAAO,MAAM,GAAG,+DAAiC,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,IAAI,EAAE,GAAG,CAAC;IACV;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;CACf"}