@pnp/sp 4.0.0-alpha0-v4nightly.20240108 → 4.0.0-alpha0-v4nightly.20240109

package/commonjs/webs/types.js

@@ -0,0 +1,227 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Web = exports._Web = exports.Webs = exports._Webs = void 0;
+const tslib_1 = require("tslib");
+const queryable_1 = require("@pnp/queryable");
+const spqueryable_js_1 = require("../spqueryable.js");
+const decorators_js_1 = require("../decorators.js");
+const odata_url_from_js_1 = require("../utils/odata-url-from.js");
+const extract_web_url_js_1 = require("../utils/extract-web-url.js");
+const core_1 = require("@pnp/core");
+const encode_path_str_js_1 = require("../utils/encode-path-str.js");
+let _Webs = class _Webs extends spqueryable_js_1._SPCollection {
+    /**
+     * Adds a new web to the collection
+     *
+     * @param title The new web's title
+     * @param url The new web's relative url
+     * @param description The new web's description
+     * @param template The new web's template internal name (default = STS)
+     * @param language The locale id that specifies the new web's language (default = 1033 [English, US])
+     * @param inheritPermissions When true, permissions will be inherited from the new web's parent (default = true)
+     */
+    async add(Title, Url, Description = "", WebTemplate = "STS", Language = 1033, UseSamePermissionsAsParentSite = true) {
+        const postBody = (0, queryable_1.body)({
+            "parameters": {
+                Description,
+                Language,
+                Title,
+                Url,
+                UseSamePermissionsAsParentSite,
+                WebTemplate,
+            },
+        });
+        const data = await (0, spqueryable_js_1.spPost)((0, exports.Webs)(this, "add"), postBody);
+        return {
+            data,
+            web: (0, exports.Web)([this, (0, odata_url_from_js_1.odataUrlFrom)(data).replace(/_api\/web\/?/i, "")]),
+        };
+    }
+};
+_Webs = (0, tslib_1.__decorate)([
+    (0, decorators_js_1.defaultPath)("webs")
+], _Webs);
+exports._Webs = _Webs;
+exports.Webs = (0, spqueryable_js_1.spInvokableFactory)(_Webs);
+/**
+ * Ensures the url passed to the constructor is correctly rebased to a web url
+ *
+ * @param candidate The candidate web url
+ * @param path The caller supplied path, which may contain _api, meaning we don't append _api/web
+ */
+function rebaseWebUrl(candidate, path) {
+    let replace = "_api/web";
+    // this allows us to both:
+    // - test if `candidate` already has an api path
+    // - ensure that we append the correct one as sometimes a web is not defined
+    //   by _api/web, in the case of _api/site/rootweb for example
+    const matches = /(_api[/|\\](site|web))/i.exec(candidate);
+    if ((matches === null || matches === void 0 ? void 0 : matches.length) > 0) {
+        // we want just the base url part (before the _api)
+        candidate = (0, extract_web_url_js_1.extractWebUrl)(candidate);
+        // we want to ensure we put back the correct string
+        replace = matches[1];
+    }
+    // we only need to append the _api part IF `path` doesn't already include it.
+    if ((path === null || path === void 0 ? void 0 : path.indexOf("_api")) < 0) {
+        candidate = (0, core_1.combine)(candidate, replace);
+    }
+    return candidate;
+}
+/**
+ * Describes a web
+ *
+ */
+let _Web = class _Web extends spqueryable_js_1._SPInstance {
+    constructor(base, path) {
+        if (typeof base === "string") {
+            base = rebaseWebUrl(base, path);
+        }
+        else if ((0, core_1.isArray)(base)) {
+            base = [base[0], rebaseWebUrl(base[1], path)];
+        }
+        else {
+            base = [base, rebaseWebUrl(base.toUrl(), path)];
+        }
+        super(base, path);
+        this.delete = (0, spqueryable_js_1.deleteable)();
+    }
+    /**
+     * Gets this web's subwebs
+     *
+     */
+    get webs() {
+        return (0, exports.Webs)(this);
+    }
+    /**
+     * Allows access to the web's all properties collection
+     */
+    get allProperties() {
+        return (0, spqueryable_js_1.SPInstance)(this, "allproperties");
+    }
+    /**
+     * Gets a collection of WebInfos for this web's subwebs
+     *
+     */
+    get webinfos() {
+        return (0, spqueryable_js_1.SPCollection)(this, "webinfos");
+    }
+    /**
+     * Gets this web's parent web and data
+     *
+     */
+    async getParentWeb() {
+        const { Url, ParentWeb } = await this.select("Url", "ParentWeb/ServerRelativeUrl").expand("ParentWeb")();
+        if (ParentWeb === null || ParentWeb === void 0 ? void 0 : ParentWeb.ServerRelativeUrl) {
+            return (0, exports.Web)([this, (0, core_1.combine)((new URL(Url)).origin, ParentWeb.ServerRelativeUrl)]);
+        }
+        return null;
+    }
+    /**
+     * Updates this web instance with the supplied properties
+     *
+     * @param properties A plain object hash of values to update for the web
+     */
+    async update(properties) {
+        return (0, spqueryable_js_1.spPostMerge)(this, (0, queryable_1.body)(properties));
+    }
+    /**
+     * Applies the theme specified by the contents of each of the files specified in the arguments to the site
+     *
+     * @param colorPaletteUrl The server-relative URL of the color palette file
+     * @param fontSchemeUrl The server-relative URL of the font scheme
+     * @param backgroundImageUrl The server-relative URL of the background image
+     * @param shareGenerated When true, the generated theme files are stored in the root site. When false, they are stored in this web
+     */
+    applyTheme(colorPaletteUrl, fontSchemeUrl, backgroundImageUrl, shareGenerated) {
+        const postBody = (0, queryable_1.body)({
+            backgroundImageUrl,
+            colorPaletteUrl,
+            fontSchemeUrl,
+            shareGenerated,
+        });
+        return (0, spqueryable_js_1.spPost)((0, exports.Web)(this, "applytheme"), postBody);
+    }
+    /**
+     * Applies the specified site definition or site template to the Web site that has no template applied to it
+     *
+     * @param template Name of the site definition or the name of the site template
+     */
+    applyWebTemplate(template) {
+        return (0, spqueryable_js_1.spPost)((0, exports.Web)(this, `applywebtemplate(webTemplate='${(0, encode_path_str_js_1.encodePath)(template)}')`));
+    }
+    /**
+     * Returns the collection of changes from the change log that have occurred within the list, based on the specified query
+     *
+     * @param query The change query
+     */
+    getChanges(query) {
+        return (0, spqueryable_js_1.spPost)((0, exports.Web)(this, "getchanges"), (0, queryable_1.body)({ query }));
+    }
+    /**
+     * Returns the name of the image file for the icon that is used to represent the specified file
+     *
+     * @param filename The file name. If this parameter is empty, the server returns an empty string
+     * @param size The size of the icon: 16x16 pixels = 0, 32x32 pixels = 1 (default = 0)
+     * @param progId The ProgID of the application that was used to create the file, in the form OLEServerName.ObjectName
+     */
+    mapToIcon(filename, size = 0, progId = "") {
+        return (0, exports.Web)(this, `maptoicon(filename='${(0, encode_path_str_js_1.encodePath)(filename)}',progid='${(0, encode_path_str_js_1.encodePath)(progId)}',size=${size})`)();
+    }
+    /**
+     * Returns the tenant property corresponding to the specified key in the app catalog site
+     *
+     * @param key Id of storage entity to be set
+     */
+    getStorageEntity(key) {
+        return (0, exports.Web)(this, `getStorageEntity('${(0, encode_path_str_js_1.encodePath)(key)}')`)();
+    }
+    /**
+     * This will set the storage entity identified by the given key (MUST be called in the context of the app catalog)
+     *
+     * @param key Id of storage entity to be set
+     * @param value Value of storage entity to be set
+     * @param description Description of storage entity to be set
+     * @param comments Comments of storage entity to be set
+     */
+    setStorageEntity(key, value, description = "", comments = "") {
+        return (0, spqueryable_js_1.spPost)((0, exports.Web)(this, "setStorageEntity"), (0, queryable_1.body)({
+            comments,
+            description,
+            key,
+            value,
+        }));
+    }
+    /**
+     * This will remove the storage entity identified by the given key
+     *
+     * @param key Id of storage entity to be removed
+     */
+    removeStorageEntity(key) {
+        return (0, spqueryable_js_1.spPost)((0, exports.Web)(this, `removeStorageEntity('${(0, encode_path_str_js_1.encodePath)(key)}')`));
+    }
+    /**
+    * Returns a collection of objects that contain metadata about subsites of the current site in which the current user is a member.
+    *
+    * @param nWebTemplateFilter Specifies the site definition (default = -1)
+    * @param nConfigurationFilter A 16-bit integer that specifies the identifier of a configuration (default = -1)
+    */
+    getSubwebsFilteredForCurrentUser(nWebTemplateFilter = -1, nConfigurationFilter = -1) {
+        return (0, spqueryable_js_1.SPCollection)(this, `getSubwebsFilteredForCurrentUser(nWebTemplateFilter=${nWebTemplateFilter},nConfigurationFilter=${nConfigurationFilter})`);
+    }
+    /**
+     * Returns a collection of site templates available for the site
+     *
+     * @param language The locale id of the site templates to retrieve (default = 1033 [English, US])
+     * @param includeCrossLanguage When true, includes language-neutral site templates; otherwise false (default = true)
+     */
+    availableWebTemplates(language = 1033, includeCrossLanugage = true) {
+        return (0, spqueryable_js_1.SPCollection)(this, `getavailablewebtemplates(lcid=${language},doincludecrosslanguage=${includeCrossLanugage})`);
+    }
+};
+_Web = (0, tslib_1.__decorate)([
+    (0, decorators_js_1.defaultPath)("_api/web")
+], _Web);
+exports._Web = _Web;
+exports.Web = (0, spqueryable_js_1.spInvokableFactory)(_Web);
+//# sourceMappingURL=types.js.map

package/commonjs/webs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/sp/webs/types.ts"],"names":[],"mappings":";;;;AAAA,8CAAsC;AACtC,sDAc2B;AAC3B,oDAA+C;AAE/C,kEAA0D;AAC1D,oEAA4D;AAC5D,oCAA6C;AAC7C,oEAAyD;AAGzD,IAAa,KAAK,GAAlB,MAAa,KAAM,SAAQ,8BAAyB;IAEhD;;;;;;;;;OASG;IACI,KAAK,CAAC,GAAG,CAAC,KAAa,EAAE,GAAW,EAAE,WAAW,GAAG,EAAE,EAAE,WAAW,GAAG,KAAK,EAAE,QAAQ,GAAG,IAAI,EAAE,8BAA8B,GAAG,IAAI;QAEtI,MAAM,QAAQ,GAAG,IAAA,gBAAI,EAAC;YAClB,YAAY,EAAE;gBACV,WAAW;gBACX,QAAQ;gBACR,KAAK;gBACL,GAAG;gBACH,8BAA8B;gBAC9B,WAAW;aACd;SACJ,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,MAAM,IAAA,uBAAM,EAAC,IAAA,YAAI,EAAC,IAAI,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;QAEvD,OAAO;YACH,IAAI;YACJ,GAAG,EAAE,IAAA,WAAG,EAAC,CAAC,IAAI,EAAE,IAAA,gCAAY,EAAC,IAAI,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,CAAC;SACpE,CAAC;IACN,CAAC;CACJ,CAAA;AAhCY,KAAK;IADjB,IAAA,2BAAW,EAAC,MAAM,CAAC;GACP,KAAK,CAgCjB;AAhCY,sBAAK;AAkCL,QAAA,IAAI,GAAG,IAAA,mCAAkB,EAAQ,KAAK,CAAC,CAAC;AAErD;;;;;GAKG;AACH,SAAS,YAAY,CAAC,SAAiB,EAAE,IAAwB;IAE7D,IAAI,OAAO,GAAG,UAAU,CAAC;IAEzB,0BAA0B;IAC1B,gDAAgD;IAChD,4EAA4E;IAC5E,8DAA8D;IAC9D,MAAM,OAAO,GAAG,yBAAyB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1D,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,IAAG,CAAC,EAAE;QACrB,mDAAmD;QACnD,SAAS,GAAG,IAAA,kCAAa,EAAC,SAAS,CAAC,CAAC;QACrC,mDAAmD;QACnD,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;KACxB;IAED,6EAA6E;IAC7E,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,CAAC,MAAM,CAAC,IAAG,CAAC,EAAE;QAC3B,SAAS,GAAG,IAAA,cAAO,EAAC,SAAS,EAAE,OAAO,CAAC,CAAC;KAC3C;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAED;;;GAGG;AAEH,IAAa,IAAI,GAAjB,MAAa,IAAK,SAAQ,4BAAqB;IAI3C,YAAY,IAAY,EAAE,IAAa;QAEnC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC1B,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;SACnC;aAAM,IAAI,IAAA,cAAO,EAAC,IAAI,CAAC,EAAE;YACtB,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;SACjD;aAAM;YACH,IAAI,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;SACnD;QAED,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAElB,IAAI,CAAC,MAAM,GAAG,IAAA,2BAAU,GAAE,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACH,IAAW,IAAI;QACX,OAAO,IAAA,YAAI,EAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAW,aAAa;QACpB,OAAO,IAAA,2BAAU,EAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,IAAW,QAAQ;QACf,OAAO,IAAA,6BAAY,EAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAY;QACrB,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,6BAA6B,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,EAA6D,CAAC;QACpK,IAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,iBAAiB,EAAE;YAC9B,OAAO,IAAA,WAAG,EAAC,CAAC,IAAI,EAAE,IAAA,cAAO,EAAC,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;SACnF;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,UAA+B;QAC/C,OAAO,IAAA,4BAAW,EAAC,IAAI,EAAE,IAAA,gBAAI,EAAC,UAAU,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACI,UAAU,CAAC,eAAuB,EAAE,aAAqB,EAAE,kBAA0B,EAAE,cAAuB;QAEjH,MAAM,QAAQ,GAAG,IAAA,gBAAI,EAAC;YAClB,kBAAkB;YAClB,eAAe;YACf,aAAa;YACb,cAAc;SACjB,CAAC,CAAC;QAEH,OAAO,IAAA,uBAAM,EAAC,IAAA,WAAG,EAAC,IAAI,EAAE,YAAY,CAAC,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,QAAgB;QAEpC,OAAO,IAAA,uBAAM,EAAC,IAAA,WAAG,EAAC,IAAI,EAAE,iCAAiC,IAAA,+BAAU,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACxF,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,KAAmB;QACjC,OAAO,IAAA,uBAAM,EAAC,IAAA,WAAG,EAAC,IAAI,EAAE,YAAY,CAAC,EAAE,IAAA,gBAAI,EAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CAAC,QAAgB,EAAE,IAAI,GAAG,CAAC,EAAE,MAAM,GAAG,EAAE;QACpD,OAAO,IAAA,WAAG,EAAC,IAAI,EAAE,uBAAuB,IAAA,+BAAU,EAAC,QAAQ,CAAC,aAAa,IAAA,+BAAU,EAAC,MAAM,CAAC,UAAU,IAAI,GAAG,CAAC,EAAE,CAAC;IACpH,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,GAAW;QAC/B,OAAO,IAAA,WAAG,EAAC,IAAI,EAAE,qBAAqB,IAAA,+BAAU,EAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;IACjE,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,GAAW,EAAE,KAAa,EAAE,WAAW,GAAG,EAAE,EAAE,QAAQ,GAAG,EAAE;QAC/E,OAAO,IAAA,uBAAM,EAAC,IAAA,WAAG,EAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,IAAA,gBAAI,EAAC;YAC9C,QAAQ;YACR,WAAW;YACX,GAAG;YACH,KAAK;SACR,CAAC,CAAC,CAAC;IACR,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,GAAW;QAClC,OAAO,IAAA,uBAAM,EAAC,IAAA,WAAG,EAAC,IAAI,EAAE,wBAAwB,IAAA,+BAAU,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;MAKE;IACK,gCAAgC,CAAC,kBAAkB,GAAG,CAAC,CAAC,EAAE,oBAAoB,GAAG,CAAC,CAAC;QACtF,OAAO,IAAA,6BAAY,EAAC,IAAI,EAAE,uDAAuD,kBAAkB,yBAAyB,oBAAoB,GAAG,CAAC,CAAC;IACzJ,CAAC;IAED;;;;;OAKG;IACI,qBAAqB,CAAC,QAAQ,GAAG,IAAI,EAAE,oBAAoB,GAAG,IAAI;QACrE,OAAO,IAAA,6BAAY,EAAC,IAAI,EAAE,iCAAiC,QAAQ,2BAA2B,oBAAoB,GAAG,CAAC,CAAC;IAC3H,CAAC;CACJ,CAAA;AAvKY,IAAI;IADhB,IAAA,2BAAW,EAAC,UAAU,CAAC;GACX,IAAI,CAuKhB;AAvKY,oBAAI;AAyKJ,QAAA,GAAG,GAAG,IAAA,mCAAkB,EAAO,IAAI,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pnp/sp",
-    "version": "4.0.0-alpha0-v4nightly.20240108",
+    "version": "4.0.0-alpha0-v4nightly.20240109",
     "description": "pnp - provides a fluent api for working with SharePoint REST",
     "main": "./esm/index.js",
     "typings": "./esm/index",
@@ -9,8 +9,8 @@
     },
     "dependencies": {
         "tslib": "2.4.1",
-        "@pnp/core": "4.0.0-alpha0-v4nightly.20240108",
-        "@pnp/queryable": "4.0.0-alpha0-v4nightly.20240108"
+        "@pnp/core": "4.0.0-alpha0-v4nightly.20240109",
+        "@pnp/queryable": "4.0.0-alpha0-v4nightly.20240109"
     },
     "type": "module",
     "engines": {