@pnp/sp 2.10.0 → 2.11.0

package/site-scripts/list.js

@@ -1,25 +1,25 @@
-import { __awaiter, __generator } from "tslib";
-import { combine } from "@pnp/common";
-import { _List, List } from "../lists/types.js";
-import { SiteScripts } from "./types.js";
-import "../folders/list.js";
-import { Web } from "../webs/types.js";
-import { extractWebUrl } from "../utils/extractweburl.js";
-_List.prototype.getSiteScript = function () {
-    return __awaiter(this, void 0, void 0, function () {
-        var rootFolder, web, absoluteListUrl;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, this.clone(List).rootFolder.get()];
-                case 1:
-                    rootFolder = _a.sent();
-                    return [4 /*yield*/, Web(extractWebUrl(this.toUrl())).configureFrom(this).select("Url").get()];
-                case 2:
-                    web = _a.sent();
-                    absoluteListUrl = combine(web.Url, "Lists", rootFolder.Name);
-                    return [2 /*return*/, SiteScripts(this, "").getSiteScriptFromList(absoluteListUrl)];
-            }
-        });
-    });
-};
+import { __awaiter, __generator } from "tslib";
+import { combine } from "@pnp/common";
+import { _List, List } from "../lists/types.js";
+import { SiteScripts } from "./types.js";
+import "../folders/list.js";
+import { Web } from "../webs/types.js";
+import { extractWebUrl } from "../utils/extractweburl.js";
+_List.prototype.getSiteScript = function () {
+    return __awaiter(this, void 0, void 0, function () {
+        var rootFolder, web, absoluteListUrl;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, this.clone(List).rootFolder.get()];
+                case 1:
+                    rootFolder = _a.sent();
+                    return [4 /*yield*/, Web(extractWebUrl(this.toUrl())).configureFrom(this).select("Url").get()];
+                case 2:
+                    web = _a.sent();
+                    absoluteListUrl = combine(web.Url, "Lists", rootFolder.Name);
+                    return [2 /*return*/, SiteScripts(this, "").getSiteScriptFromList(absoluteListUrl)];
+            }
+        });
+    });
+};
 //# sourceMappingURL=list.js.map

package/site-scripts/types.d.ts

@@ -1,184 +1,184 @@
-import { ISharePointQueryable, _SharePointQueryable } from "../sharepointqueryable.js";
-export declare class _SiteScripts extends _SharePointQueryable {
-    constructor(baseUrl: string | ISharePointQueryable, methodName?: string);
-    execute<T>(props: any): Promise<T>;
-    /**
-     * Gets a list of information on all existing site scripts.
-     */
-    getSiteScripts(): Promise<ISiteScriptInfo[]>;
-    /**
-     * Creates a new site script.
-     *
-     * @param title The display name of the site script.
-     * @param content JSON value that describes the script. For more information, see JSON reference.
-     */
-    createSiteScript(title: string, description: string, content: any): Promise<ISiteScriptInfo>;
-    /**
-     * Gets information about a specific site script. It also returns the JSON of the script.
-     *
-     * @param id The ID of the site script to get information about.
-     */
-    getSiteScriptMetadata(id: string): Promise<ISiteScriptInfo>;
-    /**
-     * Deletes a site script.
-     *
-     * @param id The ID of the site script to delete.
-     */
-    deleteSiteScript(id: string): Promise<void>;
-    /**
-     * Updates a site script with new values. In the REST call, all parameters are optional except the site script Id.
-     *
-     * @param siteScriptUpdateInfo Object that contains the information to update a site script.
-     *                             Make sure you stringify the content object or pass it in the second 'content' parameter
-     * @param content (Optional) A new JSON script defining the script actions. For more information, see Site design JSON schema.
-     */
-    updateSiteScript(updateInfo: ISiteScriptUpdateInfo, content?: any): Promise<ISiteScriptInfo>;
-    /**
-     * Gets the site script syntax (JSON) for a specific list
-     * @param listUrl The absolute url of the list to retrieve site script
-     */
-    getSiteScriptFromList(listUrl: string): Promise<string>;
-    /**
-     * Gets the site script syntax (JSON) for a specific web
-     * @param webUrl The absolute url of the web to retrieve site script
-     * @param extractInfo configuration object to specify what to extract
-     */
-    getSiteScriptFromWeb(webUrl: string, info: ISiteScriptSerializationInfo): Promise<ISiteScriptSerializationResult>;
-    /**
-     * Executes the indicated site design action on the indicated web.
-     *
-     * @param webUrl The absolute url of the web to retrieve site script
-     * @param extractInfo configuration object to specify what to extract
-     */
-    executeSiteScriptAction(actionDefinition: string): Promise<ISiteScriptActionResult>;
-}
-export interface ISiteScripts extends _SiteScripts {
-}
-export declare const SiteScripts: (baseUrl: string | ISharePointQueryable, methodName?: string) => ISiteScripts;
-/**
- * Result from creating or retrieving a site script
- *
- */
-export interface ISiteScriptInfo {
-    /**
-     * The ID of the site script to apply
-     */
-    Id: string;
-    /**
-     * The display name of the site script
-     */
-    Title: string;
-    /**
-     * The description for the site script
-     */
-    Description: string;
-    /**
-     * The JSON data/definition for the site script
-     */
-    Content: string;
-    /**
-     * The version number of the site script
-     */
-    Version: string;
-}
-/**
- * Data for updating a site script
- *
- */
-export interface ISiteScriptUpdateInfo {
-    /**
-     * The ID of the site script to update
-     */
-    Id: string;
-    /**
-     * (Optional) The new display name for the updated site script
-     */
-    Title?: string;
-    /**
-     * (Optional) The new description for the updated site script
-     */
-    Description?: string;
-    /**
-     * (Optional) The new JSON data/definition for the updated site script
-     */
-    Content?: string;
-    /**
-     * (Optional) The new version for the updated site script
-     */
-    Version?: string;
-}
-export interface ISiteScriptSerializationInfo {
-    /**
-     * (Optional) Include branding
-     */
-    IncludeBranding?: boolean;
-    /**
-     * (Optional) Lists to include e.g. ["Lists/MyList"]
-     */
-    IncludedLists?: string[];
-    /**
-     * (Optional) Include links to exported items
-     */
-    IncludeLinksToExportedItems?: boolean;
-    /**
-     * (Optional) Include regional settings
-     */
-    IncludeRegionalSettings?: boolean;
-    /**
-     * (Optional) Include site external sharing capability
-     */
-    IncludeSiteExternalSharingCapability?: boolean;
-    /**
-     * (Optional) Include theme
-     */
-    IncludeTheme?: boolean;
-}
-export interface ISiteScriptSerializationResult {
-    /**
-     * The site script in JSON format
-     */
-    JSON: string;
-    /**
-    * A collection of warnings
-    */
-    Warnings: string[];
-}
-export interface ISiteScriptActionResult {
-    /**
-     * The title of the action.
-     */
-    Title: string;
-    /**
-     * Text associated with the outcome of the action. If this is present, it is usually an error message.
-     */
-    OutcomeText: string;
-    /**
-     * Indicates the outcome of the action.
-     */
-    Outcome: SiteScriptActionOutcome;
-    /**
-     * Indicates the target of the action.
-     */
-    Target: string;
-}
-export declare enum SiteScriptActionOutcome {
-    /**
-     * The stage was deemed to have completed successfully.
-     */
-    Success = 0,
-    /**
-     * The stage was deemed to have failed to complete successfully (non-blocking, rest of recipe
-     * execution should still be able to proceed).
-     */
-    Failure = 1,
-    /**
-     * No action was taken for this stage / this stage was skipped.
-     */
-    NoOp = 2,
-    /**
-     * There was an exception but the operation succeeded. This is analagous to the operation completing
-     * in a "yellow" state.
-     */
-    SucceededWithException = 3
-}
+import { ISharePointQueryable, _SharePointQueryable } from "../sharepointqueryable.js";
+export declare class _SiteScripts extends _SharePointQueryable {
+    constructor(baseUrl: string | ISharePointQueryable, methodName?: string);
+    execute<T>(props: any): Promise<T>;
+    /**
+     * Gets a list of information on all existing site scripts.
+     */
+    getSiteScripts(): Promise<ISiteScriptInfo[]>;
+    /**
+     * Creates a new site script.
+     *
+     * @param title The display name of the site script.
+     * @param content JSON value that describes the script. For more information, see JSON reference.
+     */
+    createSiteScript(title: string, description: string, content: any): Promise<ISiteScriptInfo>;
+    /**
+     * Gets information about a specific site script. It also returns the JSON of the script.
+     *
+     * @param id The ID of the site script to get information about.
+     */
+    getSiteScriptMetadata(id: string): Promise<ISiteScriptInfo>;
+    /**
+     * Deletes a site script.
+     *
+     * @param id The ID of the site script to delete.
+     */
+    deleteSiteScript(id: string): Promise<void>;
+    /**
+     * Updates a site script with new values. In the REST call, all parameters are optional except the site script Id.
+     *
+     * @param siteScriptUpdateInfo Object that contains the information to update a site script.
+     *                             Make sure you stringify the content object or pass it in the second 'content' parameter
+     * @param content (Optional) A new JSON script defining the script actions. For more information, see Site design JSON schema.
+     */
+    updateSiteScript(updateInfo: ISiteScriptUpdateInfo, content?: any): Promise<ISiteScriptInfo>;
+    /**
+     * Gets the site script syntax (JSON) for a specific list
+     * @param listUrl The absolute url of the list to retrieve site script
+     */
+    getSiteScriptFromList(listUrl: string): Promise<string>;
+    /**
+     * Gets the site script syntax (JSON) for a specific web
+     * @param webUrl The absolute url of the web to retrieve site script
+     * @param extractInfo configuration object to specify what to extract
+     */
+    getSiteScriptFromWeb(webUrl: string, info: ISiteScriptSerializationInfo): Promise<ISiteScriptSerializationResult>;
+    /**
+     * Executes the indicated site design action on the indicated web.
+     *
+     * @param webUrl The absolute url of the web to retrieve site script
+     * @param extractInfo configuration object to specify what to extract
+     */
+    executeSiteScriptAction(actionDefinition: string): Promise<ISiteScriptActionResult>;
+}
+export interface ISiteScripts extends _SiteScripts {
+}
+export declare const SiteScripts: (baseUrl: string | ISharePointQueryable, methodName?: string) => ISiteScripts;
+/**
+ * Result from creating or retrieving a site script
+ *
+ */
+export interface ISiteScriptInfo {
+    /**
+     * The ID of the site script to apply
+     */
+    Id: string;
+    /**
+     * The display name of the site script
+     */
+    Title: string;
+    /**
+     * The description for the site script
+     */
+    Description: string;
+    /**
+     * The JSON data/definition for the site script
+     */
+    Content: string;
+    /**
+     * The version number of the site script
+     */
+    Version: string;
+}
+/**
+ * Data for updating a site script
+ *
+ */
+export interface ISiteScriptUpdateInfo {
+    /**
+     * The ID of the site script to update
+     */
+    Id: string;
+    /**
+     * (Optional) The new display name for the updated site script
+     */
+    Title?: string;
+    /**
+     * (Optional) The new description for the updated site script
+     */
+    Description?: string;
+    /**
+     * (Optional) The new JSON data/definition for the updated site script
+     */
+    Content?: string;
+    /**
+     * (Optional) The new version for the updated site script
+     */
+    Version?: string;
+}
+export interface ISiteScriptSerializationInfo {
+    /**
+     * (Optional) Include branding
+     */
+    IncludeBranding?: boolean;
+    /**
+     * (Optional) Lists to include e.g. ["Lists/MyList"]
+     */
+    IncludedLists?: string[];
+    /**
+     * (Optional) Include links to exported items
+     */
+    IncludeLinksToExportedItems?: boolean;
+    /**
+     * (Optional) Include regional settings
+     */
+    IncludeRegionalSettings?: boolean;
+    /**
+     * (Optional) Include site external sharing capability
+     */
+    IncludeSiteExternalSharingCapability?: boolean;
+    /**
+     * (Optional) Include theme
+     */
+    IncludeTheme?: boolean;
+}
+export interface ISiteScriptSerializationResult {
+    /**
+     * The site script in JSON format
+     */
+    JSON: string;
+    /**
+    * A collection of warnings
+    */
+    Warnings: string[];
+}
+export interface ISiteScriptActionResult {
+    /**
+     * The title of the action.
+     */
+    Title: string;
+    /**
+     * Text associated with the outcome of the action. If this is present, it is usually an error message.
+     */
+    OutcomeText: string;
+    /**
+     * Indicates the outcome of the action.
+     */
+    Outcome: SiteScriptActionOutcome;
+    /**
+     * Indicates the target of the action.
+     */
+    Target: string;
+}
+export declare enum SiteScriptActionOutcome {
+    /**
+     * The stage was deemed to have completed successfully.
+     */
+    Success = 0,
+    /**
+     * The stage was deemed to have failed to complete successfully (non-blocking, rest of recipe
+     * execution should still be able to proceed).
+     */
+    Failure = 1,
+    /**
+     * No action was taken for this stage / this stage was skipped.
+     */
+    NoOp = 2,
+    /**
+     * There was an exception but the operation succeeded. This is analagous to the operation completing
+     * in a "yellow" state.
+     */
+    SucceededWithException = 3
+}
 //# sourceMappingURL=types.d.ts.map