@pnp/sp 3.21.0-v4nightly.20240117 → 3.22.0

package/esm/sites/types.js

@@ -1,258 +0,0 @@
-import { __decorate } from "tslib";
-import { _SPInstance, spInvokableFactory, SPQueryable, spPatch, spPost } from "../spqueryable.js";
-import { defaultPath } from "../decorators.js";
-import { Web } from "../webs/types.js";
-import { combine, hOP, isArray } from "@pnp/core";
-import { body, TextParse } from "@pnp/queryable";
-import { odataUrlFrom } from "../utils/odata-url-from.js";
-import { extractWebUrl } from "../utils/extract-web-url.js";
-import { emptyGuid } from "../types.js";
-/**
- * Ensures that whatever url is passed to the constructor we can correctly rebase it to a site url
- *
- * @param candidate The candidate site url
- * @param path The caller supplied path, which may contain _api, meaning we don't append _api/site
- */
-function rebaseSiteUrl(candidate, path) {
-    let replace = "_api/site";
-    // 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 = 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 = combine(candidate, replace);
-    }
-    return candidate;
-}
-let _Site = class _Site extends _SPInstance {
-    constructor(base, path) {
-        if (typeof base === "string") {
-            base = rebaseSiteUrl(base, path);
-        }
-        else if (isArray(base)) {
-            base = [base[0], rebaseSiteUrl(base[1], path)];
-        }
-        else {
-            base = [base, rebaseSiteUrl(base.toUrl(), path)];
-        }
-        super(base, path);
-    }
-    /**
-     * Gets the root web of the site collection
-     *
-     */
-    get rootWeb() {
-        return Web(this, "rootweb");
-    }
-    /**
-     * 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) {
-        const postBody = body({ query });
-        return spPost(Web(this, "getchanges"), postBody);
-    }
-    /**
-     * Opens a web by id (using POST)
-     *
-     * @param webId The GUID id of the web to open
-     */
-    async openWebById(webId) {
-        const data = await spPost(Site(this, `openWebById('${webId}')`));
-        return {
-            data,
-            web: Web([this, extractWebUrl(odataUrlFrom(data))]),
-        };
-    }
-    /**
-     * Gets a Web instance representing the root web of the site collection
-     * correctly setup for chaining within the library
-     */
-    async getRootWeb() {
-        const web = await this.rootWeb.select("Url")();
-        return Web([this, web.Url]);
-    }
-    /**
-     * Deletes the current site
-     *
-     */
-    async delete() {
-        const site = await Site(this, "").select("Id")();
-        const q = Site([this, this.parentUrl], "_api/SPSiteManager/Delete");
-        await spPost(q, body({ siteId: site.Id }));
-    }
-    /**
-     * Gets the document libraries on a site. Static method. (SharePoint Online only)
-     *
-     * @param absoluteWebUrl The absolute url of the web whose document libraries should be returned
-     */
-    async getDocumentLibraries(absoluteWebUrl) {
-        const q = Site([this, this.parentUrl], "_api/sp.web.getdocumentlibraries(@v)");
-        q.query.set("@v", `'${absoluteWebUrl}'`);
-        const data = await q();
-        return hOP(data, "GetDocumentLibraries") ? data.GetDocumentLibraries : data;
-    }
-    /**
-     * Gets the site url from a page url
-     *
-     * @param absolutePageUrl The absolute url of the page
-     */
-    async getWebUrlFromPageUrl(absolutePageUrl) {
-        const q = Site([this, this.parentUrl], "_api/sp.web.getweburlfrompageurl(@v)");
-        q.query.set("@v", `'${absolutePageUrl}'`);
-        const data = await q();
-        return hOP(data, "GetWebUrlFromPageUrl") ? data.GetWebUrlFromPageUrl : data;
-    }
-    /**
-     * Creates a Modern communication site.
-     *
-     * @param title The title of the site to create
-     * @param lcid The language to use for the site. If not specified will default to 1033 (English).
-     * @param shareByEmailEnabled If set to true, it will enable sharing files via Email. By default it is set to false
-     * @param url The fully qualified URL (e.g. https://yourtenant.sharepoint.com/sites/mysitecollection) of the site.
-     * @param description The description of the communication site.
-     * @param classification The Site classification to use. For instance 'Contoso Classified'. See https://www.youtube.com/watch?v=E-8Z2ggHcS0 for more information
-     * @param siteDesignId The Guid of the site design to be used.
-     *                     You can use the below default OOTB GUIDs:
-     *                     Topic: 00000000-0000-0000-0000-000000000000
-     *                     Showcase: 6142d2a0-63a5-4ba0-aede-d9fefca2c767
-     *                     Blank: f6cc5403-0d63-442e-96c0-285923709ffc
-     * @param hubSiteId The id of the hub site to which the new site should be associated
-     * @param owner Optional owner value, required if executing the method in app only mode
-     */
-    async createCommunicationSite(title, lcid = 1033, shareByEmailEnabled = false, url, description, classification, siteDesignId, hubSiteId, owner) {
-        return this.createCommunicationSiteFromProps({
-            Classification: classification,
-            Description: description,
-            HubSiteId: hubSiteId,
-            Lcid: lcid,
-            Owner: owner,
-            ShareByEmailEnabled: shareByEmailEnabled,
-            SiteDesignId: siteDesignId,
-            Title: title,
-            Url: url,
-        });
-    }
-    async createCommunicationSiteFromProps(props) {
-        // handle defaults
-        const request = {
-            Classification: "",
-            Description: "",
-            HubSiteId: emptyGuid,
-            Lcid: 1033,
-            ShareByEmailEnabled: false,
-            SiteDesignId: emptyGuid,
-            WebTemplate: "SITEPAGEPUBLISHING#0",
-            WebTemplateExtensionId: emptyGuid,
-            ...props,
-        };
-        return spPost(Site([this, extractWebUrl(this.toUrl())], "/_api/SPSiteManager/Create"), body({ request }));
-    }
-    /**
-     *
-     * @param url Site Url that you want to check if exists
-     */
-    async exists(url) {
-        return spPost(Site([this, extractWebUrl(this.toUrl())], "/_api/SP.Site.Exists"), body({ url }));
-    }
-    /**
-     * Creates a Modern team site backed by Office 365 group. For use in SP Online only. This will not work with App-only tokens
-     *
-     * @param displayName The title or display name of the Modern team site to be created
-     * @param alias Alias of the underlying Office 365 Group
-     * @param isPublic Defines whether the Office 365 Group will be public (default), or private.
-     * @param lcid The language to use for the site. If not specified will default to English (1033).
-     * @param description The description of the site to be created.
-     * @param classification The Site classification to use. For instance 'Contoso Classified'. See https://www.youtube.com/watch?v=E-8Z2ggHcS0 for more information
-     * @param owners The Owners of the site to be created
-     */
-    async createModernTeamSite(displayName, alias, isPublic, lcid, description, classification, owners, hubSiteId, siteDesignId) {
-        return this.createModernTeamSiteFromProps({
-            alias,
-            classification,
-            description,
-            displayName,
-            hubSiteId,
-            isPublic,
-            lcid,
-            owners,
-            siteDesignId,
-        });
-    }
-    async createModernTeamSiteFromProps(props) {
-        // handle defaults
-        const p = Object.assign({}, {
-            classification: "",
-            description: "",
-            hubSiteId: emptyGuid,
-            isPublic: true,
-            lcid: 1033,
-            owners: [],
-        }, props);
-        const postBody = {
-            alias: p.alias,
-            displayName: p.displayName,
-            isPublic: p.isPublic,
-            optionalParams: {
-                Classification: p.classification,
-                CreationOptions: [`SPSiteLanguage:${p.lcid}`, `HubSiteId:${p.hubSiteId}`],
-                Description: p.description,
-                Owners: p.owners,
-            },
-        };
-        if (p.siteDesignId) {
-            postBody.optionalParams.CreationOptions.push(`implicit_formula_292aa8a00786498a87a5ca52d9f4214a_${p.siteDesignId}`);
-        }
-        return spPost(Site([this, extractWebUrl(this.toUrl())], "/_api/GroupSiteManager/CreateGroupEx").using(TextParse()), body(postBody));
-    }
-    update(props) {
-        return spPatch(this, body(props));
-    }
-    /**
-     * Set's the site's `Site Logo` property, vs the Site Icon property available on the web's properties
-     *
-     * @param logoProperties An instance of ISiteLogoProperties which sets the new site logo.
-     */
-    setSiteLogo(logoProperties) {
-        return spPost(SPQueryable([this, extractWebUrl(this.toUrl())], "_api/siteiconmanager/setsitelogo"), body(logoProperties));
-    }
-};
-_Site = __decorate([
-    defaultPath("_api/site")
-], _Site);
-export { _Site };
-export const Site = spInvokableFactory(_Site);
-export var SiteLogoType;
-(function (SiteLogoType) {
-    /**
-     * Site header logo
-     */
-    SiteLogoType[SiteLogoType["WebLogo"] = 0] = "WebLogo";
-    /**
-     * Hub site logo
-     */
-    SiteLogoType[SiteLogoType["HubLogo"] = 1] = "HubLogo";
-    /**
-     * Header background image
-     */
-    SiteLogoType[SiteLogoType["HeaderBackground"] = 2] = "HeaderBackground";
-    /**
-     * Global navigation logo
-     */
-    SiteLogoType[SiteLogoType["GlobalNavLogo"] = 3] = "GlobalNavLogo";
-})(SiteLogoType || (SiteLogoType = {}));
-export var SiteLogoAspect;
-(function (SiteLogoAspect) {
-    SiteLogoAspect[SiteLogoAspect["Square"] = 0] = "Square";
-    SiteLogoAspect[SiteLogoAspect["Rectangular"] = 1] = "Rectangular";
-})(SiteLogoAspect || (SiteLogoAspect = {}));
-//# sourceMappingURL=types.js.map

package/esm/sites/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/sp/sites/types.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAU,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC1G,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,GAAG,EAAQ,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;GAKG;AACH,SAAS,aAAa,CAAC,SAAiB,EAAE,IAAwB;IAE9D,IAAI,OAAO,GAAG,WAAW,CAAC;IAE1B,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;QAErB,mDAAmD;QACnD,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;QAErC,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,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;KAC3C;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAGD,IAAa,KAAK,GAAlB,MAAa,KAAM,SAAQ,WAAsB;IAE7C,YAAY,IAAY,EAAE,IAAa;QAEnC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC1B,IAAI,GAAG,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;SACpC;aAAM,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;YACtB,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;SAClD;aAAM;YACH,IAAI,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;SACpD;QAED,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,IAAW,OAAO;QACd,OAAO,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,KAAmB;QAEjC,MAAM,QAAQ,GAAG,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QACjC,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,KAAa;QAClC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC,CAAC,CAAC;QACjE,OAAO;YACH,IAAI;YACJ,GAAG,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACtD,CAAC;IACN,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU;QACnB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAmB,CAAC;QAChE,OAAO,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM;QAEf,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAkB,CAAC;QACjE,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,2BAA2B,CAAC,CAAC;QACpE,MAAM,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,cAAsB;QACpD,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,sCAAsC,CAAC,CAAC;QAC/E,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,cAAc,GAAG,CAAC,CAAC;QACzC,MAAM,IAAI,GAAG,MAAM,CAAC,EAAO,CAAC;QAC5B,OAAO,GAAG,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC;IAChF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAAC,eAAuB;QAErD,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,sCAAsC,CAAC,CAAC;QAC/E,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,eAAe,GAAG,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,EAAO,CAAC;QAC5B,OAAO,GAAG,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,uBAAuB,CAChC,KAAa,EACb,IAAI,GAAG,IAAI,EACX,mBAAmB,GAAG,KAAK,EAC3B,GAAW,EACX,WAAoB,EACpB,cAAuB,EACvB,YAAqB,EACrB,SAAkB,EAClB,KAAc;QAGd,OAAO,IAAI,CAAC,gCAAgC,CAAC;YACzC,cAAc,EAAE,cAAc;YAC9B,WAAW,EAAE,WAAW;YACxB,SAAS,EAAE,SAAS;YACpB,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,KAAK;YACZ,mBAAmB,EAAE,mBAAmB;YACxC,YAAY,EAAE,YAAY;YAC1B,KAAK,EAAE,KAAK;YACZ,GAAG,EAAE,GAAG;SACX,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,gCAAgC,CAAC,KAA2B;QAErE,kBAAkB;QAClB,MAAM,OAAO,GAAG;YACZ,cAAc,EAAE,EAAE;YAClB,WAAW,EAAE,EAAE;YACf,SAAS,EAAE,SAAS;YACpB,IAAI,EAAE,IAAI;YACV,mBAAmB,EAAE,KAAK;YAC1B,YAAY,EAAE,SAAS;YACvB,WAAW,EAAE,sBAAsB;YACnC,sBAAsB,EAAE,SAAS;YACjC,GAAG,KAAK;SACX,CAAC;QAEF,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,4BAA4B,CAAC,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IAC9G,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,GAAW;QAE3B,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,sBAAsB,CAAC,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,oBAAoB,CAC7B,WAAmB,EACnB,KAAa,EACb,QAAkB,EAClB,IAAa,EACb,WAAoB,EACpB,cAAuB,EACvB,MAAiB,EACjB,SAAkB,EAClB,YAAqB;QAGrB,OAAO,IAAI,CAAC,6BAA6B,CAAC;YACtC,KAAK;YACL,cAAc;YACd,WAAW;YACX,WAAW;YACX,SAAS;YACT,QAAQ;YACR,IAAI;YACJ,MAAM;YACN,YAAY;SACf,CAAC,CAAC;IACP,CAAC;IAEM,KAAK,CAAC,6BAA6B,CAAC,KAA2B;QAElE,kBAAkB;QAClB,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE;YACxB,cAAc,EAAE,EAAE;YAClB,WAAW,EAAE,EAAE;YACf,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,EAAE;SACb,EAAE,KAAK,CAAC,CAAC;QAEV,MAAM,QAAQ,GAAG;YACb,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,WAAW,EAAE,CAAC,CAAC,WAAW;YAC1B,QAAQ,EAAE,CAAC,CAAC,QAAQ;YACpB,cAAc,EAAE;gBACZ,cAAc,EAAE,CAAC,CAAC,cAAc;gBAChC,eAAe,EAAE,CAAC,kBAAkB,CAAC,CAAC,IAAI,EAAE,EAAE,aAAa,CAAC,CAAC,SAAS,EAAE,CAAC;gBAEzE,WAAW,EAAE,CAAC,CAAC,WAAW;gBAC1B,MAAM,EAAE,CAAC,CAAC,MAAM;aACnB;SACJ,CAAC;QAEF,IAAI,CAAC,CAAC,YAAY,EAAE;YAChB,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,IAAI,CAAC,qDAAqD,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC;SACvH;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,sCAAsC,CAAC,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxI,CAAC;IAEM,MAAM,CAAC,KAAgB;QAE1B,OAAO,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,cAAmC;QAClD,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,kCAAkC,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAE,CAAC;IAC/H,CAAC;CACJ,CAAA;AAlPY,KAAK;IADjB,WAAW,CAAC,WAAW,CAAC;GACZ,KAAK,CAkPjB;SAlPY,KAAK;AAoPlB,MAAM,CAAC,MAAM,IAAI,GAAG,kBAAkB,CAAQ,KAAK,CAAC,CAAC;AAyGrD,MAAM,CAAN,IAAkB,YAiBjB;AAjBD,WAAkB,YAAY;IAC1B;;OAEG;IACH,qDAAW,CAAA;IACX;;OAEG;IACH,qDAAW,CAAA;IACX;;OAEG;IACH,uEAAoB,CAAA;IACpB;;OAEG;IACH,iEAAiB,CAAA;AACrB,CAAC,EAjBiB,YAAY,KAAZ,YAAY,QAiB7B;AAED,MAAM,CAAN,IAAkB,cAGjB;AAHD,WAAkB,cAAc;IAC5B,uDAAU,CAAA;IACV,iEAAe,CAAA;AACnB,CAAC,EAHiB,cAAc,KAAd,cAAc,QAG/B"}

package/esm/social/index.d.ts

@@ -1,11 +0,0 @@
-import { ISocial } from "./types.js";
-export { IMySocial, ISocial, IMySocialData, ISocialActor, ISocialActorInfo, MySocial, Social, SocialActorType, SocialActorTypes, SocialFollowResult, SocialStatusCode, } from "./types.js";
-declare module "../fi" {
-    interface SPFI {
-        /**
-         * Access to the social instance which allows you to track followed sites, people and docs.
-         */
-        readonly social: ISocial;
-    }
-}
-//# sourceMappingURL=index.d.ts.map

package/esm/social/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/social/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAU,MAAM,YAAY,CAAC;AAG7C,OAAO,EACH,SAAS,EACT,OAAO,EACP,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,QAAQ,EACR,MAAM,EACN,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,GACnB,MAAM,YAAY,CAAC;AAEpB,OAAO,QAAQ,OAAO,CAAC;IACnB,UAAU,IAAI;QACV;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;KAC5B;CACJ"}

package/esm/social/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/sp/social/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,MAAM,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAEhC,OAAO,EAMH,QAAQ,EACR,MAAM,EACN,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,GACnB,MAAM,YAAY,CAAC;AAWpB,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE;IAC7C,YAAY,EAAE,IAAI;IAClB,UAAU,EAAE,IAAI;IAChB,GAAG,EAAE;QACD,OAAO,IAAI,CAAC,MAAM,CAAM,MAAM,CAAC,CAAC;IACpC,CAAC;CACJ,CAAC,CAAC"}

package/esm/social/types.d.ts

@@ -1,305 +0,0 @@
-import { _SPInstance, ISPQueryable, SPInit } from "../spqueryable.js";
-export declare class _Social extends _SPInstance implements ISocial {
-    get my(): IMySocial;
-    getFollowedSitesUri(): Promise<string>;
-    getFollowedDocumentsUri(): Promise<string>;
-    follow(actorInfo: ISocialActorInfo): Promise<SocialFollowResult>;
-    isFollowed(actorInfo: ISocialActorInfo): Promise<boolean>;
-    stopFollowing(actorInfo: ISocialActorInfo): Promise<void>;
-    private createSocialActorInfoRequestBody;
-}
-/**
- * Get a new Social instance for the particular Url
- */
-export declare const Social: (baseUrl: SPInit) => ISocial;
-/**
- * Current user's Social instance
- */
-export declare class _MySocial extends _SPInstance {
-    followed(types: SocialActorTypes): Promise<ISocialActor[]>;
-    followedCount(types: SocialActorTypes): Promise<number>;
-    followers(): Promise<ISocialActor[]>;
-    suggestions(): Promise<ISocialActor[]>;
-}
-/**
- * Invokable factory for IMySocial instances
- */
-export declare const MySocial: (baseUrl: string | ISPQueryable, path?: string) => IMySocial;
-/**
- * Describes the public methods for the Social interface
- */
-export interface ISocial {
-    /**
-   * Access to the curren't user's social data
-   */
-    readonly my: IMySocial;
-    /**
-   * Get a list of followed sites for the current user.
-   */
-    getFollowedSitesUri(): Promise<string>;
-    /**
-   * Get a list of followed documents for the current user.
-   */
-    getFollowedDocumentsUri(): Promise<string>;
-    /**
-   * Follow an actor for the current user.
-   *
-   * @param actorInfo Provide the actor to follow.
-   */
-    follow(actorInfo: ISocialActorInfo): Promise<SocialFollowResult>;
-    /**
-   * Check if the current user is following the actor.
-   *
-   * @param actorInfo Provide the actor to check.
-   */
-    isFollowed(actorInfo: ISocialActorInfo): Promise<boolean>;
-    /**
-   * Stop following an actor for the current user.
-   *
-   * @param actorInfo Provide the actor to stop following.
-   */
-    stopFollowing(actorInfo: ISocialActorInfo): Promise<void>;
-}
-/**
- * Defines the public methods exposed by the my endpoint
- */
-export interface IMySocial {
-    /**
-     * Allow access to the v2 invokable
-     */
-    (this: IMySocial): Promise<IMySocialData>;
-    /**
-     * Gets users, documents, sites, and tags that the current user is following.
-     *
-     * @param types Bitwise set of SocialActorTypes to retrieve
-     */
-    followed(types: SocialActorTypes): Promise<ISocialActor[]>;
-    /**
-     * Gets the count of users, documents, sites, and tags that the current user is following.
-     *
-     * @param types Bitwise set of SocialActorTypes to retrieve
-     */
-    followedCount(types: SocialActorTypes): Promise<number>;
-    /**
-     * Gets the users who are following the current user.
-     */
-    followers(): Promise<ISocialActor[]>;
-    /**
-     * Gets users who the current user might want to follow.
-     */
-    suggestions(): Promise<ISocialActor[]>;
-}
-/**
- * Social actor info
- *
- */
-export interface ISocialActorInfo {
-    AccountName?: string;
-    ActorType: SocialActorType;
-    ContentUri?: string;
-    Id?: string;
-    TagGuid?: string;
-}
-/**
- * Social actor type
- *
- */
-export declare const enum SocialActorType {
-    User = 0,
-    Document = 1,
-    Site = 2,
-    Tag = 3
-}
-/**
- * Social actor type
- *
- */
-export declare const enum SocialActorTypes {
-    None = 0,
-    User = 1,
-    Document = 2,
-    Site = 4,
-    Tag = 8,
-    /**
-   * The set excludes documents and sites that do not have feeds.
-   */
-    ExcludeContentWithoutFeeds = 268435456,
-    /**
-   * The set includes group sites
-   */
-    IncludeGroupsSites = 536870912,
-    /**
-   * The set includes only items created within the last 24 hours
-   */
-    WithinLast24Hours = 1073741824
-}
-/**
- * Result from following
- *
- */
-export declare const enum SocialFollowResult {
-    Ok = 0,
-    AlreadyFollowing = 1,
-    LimitReached = 2,
-    InternalError = 3
-}
-/**
- * Specifies an exception or status code.
- */
-export declare const enum SocialStatusCode {
-    /**
-   * The operation completed successfully
-   */
-    OK = 0,
-    /**
-   * The request is invalid.
-   */
-    InvalidRequest = 1,
-    /**
-   *  The current user is not authorized to perform the operation.
-   */
-    AccessDenied = 2,
-    /**
-   * The target of the operation was not found.
-   */
-    ItemNotFound = 3,
-    /**
-   * The operation is invalid for the target's current state.
-   */
-    InvalidOperation = 4,
-    /**
-   * The operation completed without modifying the target.
-   */
-    ItemNotModified = 5,
-    /**
-   * The operation failed because an internal error occurred.
-   */
-    InternalError = 6,
-    /**
-   * The operation failed because the server could not access the distributed cache.
-   */
-    CacheReadError = 7,
-    /**
-   * The operation succeeded but the server could not update the distributed cache.
-   */
-    CacheUpdateError = 8,
-    /**
-   * No personal site exists for the current user, and no further information is available.
-   */
-    PersonalSiteNotFound = 9,
-    /**
-   * No personal site exists for the current user, and a previous attempt to create one failed.
-   */
-    FailedToCreatePersonalSite = 10,
-    /**
-   * No personal site exists for the current user, and a previous attempt to create one was not authorized.
-   */
-    NotAuthorizedToCreatePersonalSite = 11,
-    /**
-   * No personal site exists for the current user, and no attempt should be made to create one.
-   */
-    CannotCreatePersonalSite = 12,
-    /**
-   * The operation was rejected because an internal limit had been reached.
-   */
-    LimitReached = 13,
-    /**
-   * The operation failed because an error occurred during the processing of the specified attachment.
-   */
-    AttachmentError = 14,
-    /**
-   * The operation succeeded with recoverable errors; the returned data is incomplete.
-   */
-    PartialData = 15,
-    /**
-   * A required SharePoint feature is not enabled.
-   */
-    FeatureDisabled = 16,
-    /**
-   * The site's storage quota has been exceeded.
-   */
-    StorageQuotaExceeded = 17,
-    /**
-   * The operation failed because the server could not access the database.
-   */
-    DatabaseError = 18
-}
-export interface ISocialActor {
-    /**
-   * Gets the actor type.
-   */
-    ActorType: SocialActorType;
-    /**
-   * Gets the actor's unique identifier.
-   */
-    Id: string;
-    /**
-   * Gets the actor's canonical URI.
-   */
-    Uri: string;
-    /**
-   * Gets the actor's display name.
-   */
-    Name: string;
-    /**
-   * Returns true if the current user is following the actor, false otherwise.
-   */
-    IsFollowed: boolean;
-    /**
-   * Gets a code that indicates recoverable errors that occurred during actor retrieval
-   */
-    Status: SocialStatusCode;
-    /**
-   * Returns true if the Actor can potentially be followed, false otherwise.
-   */
-    CanFollow: boolean;
-    /**
-   * Gets the actor's image URI. Only valid when ActorType is User, Document, or Site
-   */
-    ImageUri: string;
-    /**
-   * Gets the actor's account name. Only valid when ActorType is User
-   */
-    AccountName: string;
-    /**
-   * Gets the actor's email address. Only valid when ActorType is User
-   */
-    EmailAddress: string;
-    /**
-   * Gets the actor's title. Only valid when ActorType is User
-   */
-    Title: string;
-    /**
-   * Gets the text of the actor's most recent post. Only valid when ActorType is User
-   */
-    StatusText: string;
-    /**
-   * Gets the URI of the actor's personal site. Only valid when ActorType is User
-   */
-    PersonalSiteUri: string;
-    /**
-   * Gets the URI of the actor's followed content folder. Only valid when this represents the current user
-   */
-    FollowedContentUri: string;
-    /**
-   * Gets the actor's content URI. Only valid when ActorType is Document, or Site
-   */
-    ContentUri: string;
-    /**
-   * Gets the actor's library URI. Only valid when ActorType is Document
-   */
-    LibraryUri: string;
-    /**
-   * Gets the actor's tag GUID. Only valid when ActorType is Tag
-   */
-    TagGuid: string;
-}
-/**
- * Defines the properties returned from the my endpoint
- */
-export interface IMySocialData {
-    SocialActor: ISocialActor;
-    MyFollowedDocumentsUri: string;
-    MyFollowedSitesUri: string;
-}
-//# sourceMappingURL=types.d.ts.map

package/esm/social/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/social/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,WAAW,EACX,YAAY,EACZ,MAAM,EAET,MAAM,mBAAmB,CAAC;AAK3B,qBACa,OAAQ,SAAQ,WAAY,YAAW,OAAO;IAEvD,IAAW,EAAE,IAAI,SAAS,CAEzB;IAEY,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC;IAKtC,uBAAuB,IAAI,OAAO,CAAC,MAAM,CAAC;IAK1C,MAAM,CAAC,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIhE,UAAU,CAAC,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzD,aAAa,CAAC,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAItE,OAAO,CAAC,gCAAgC;CAQ3C;AAED;;GAEG;AACH,eAAO,MAAM,MAAM,YAAa,MAAM,KAAG,OAA+B,CAAC;AAGzE;;GAEG;AACH,qBACa,SAAU,SAAQ,WAAW;IAGzB,QAAQ,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAM1D,aAAa,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAMvD,SAAS,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAMpC,WAAW,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;CAItD;AAED;;GAEG;AACH,eAAO,MAAM,QAAQ,YAAa,MAAM,GAAG,YAAY,SAAS,MAAM,KAAG,SAAyC,CAAC;AAGnH;;GAEG;AACH,MAAM,WAAW,OAAO;IACpB;;KAEC;IACD,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC;IACvB;;KAEC;IACD,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACvC;;KAEC;IACD,uBAAuB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3C;;;;KAIC;IACD,MAAM,CAAC,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACjE;;;;KAIC;IACD,UAAU,CAAC,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1D;;;;KAIC;IACD,aAAa,CAAC,SAAS,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IAEtB;;OAEG;IACH,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAE1C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAC3D;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACxD;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IACrC;;OAEG;IACH,WAAW,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,eAAe,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,0BAAkB,eAAe;IAC7B,IAAI,IAAA;IACJ,QAAQ,IAAA;IACR,IAAI,IAAA;IACJ,GAAG,IAAA;CACN;AAED;;;GAGG;AAEH,0BAAkB,gBAAgB;IAC9B,IAAI,IAAI;IACR,IAAI,IAA4B;IAChC,QAAQ,IAAgC;IACxC,IAAI,IAA4B;IAChC,GAAG,IAA2B;IAC9B;;KAEC;IACD,0BAA0B,YAAY;IACtC;;KAEC;IACD,kBAAkB,YAAY;IAC9B;;KAEC;IACD,iBAAiB,aAAa;CACjC;AAGD;;;GAGG;AACH,0BAAkB,kBAAkB;IAChC,EAAE,IAAI;IACN,gBAAgB,IAAI;IACpB,YAAY,IAAI;IAChB,aAAa,IAAI;CACpB;AAED;;GAEG;AACH,0BAAkB,gBAAgB;IAC9B;;KAEC;IACD,EAAE,IAAA;IACF;;KAEC;IACD,cAAc,IAAA;IACd;;KAEC;IACD,YAAY,IAAA;IACZ;;KAEC;IACD,YAAY,IAAA;IACZ;;KAEC;IACD,gBAAgB,IAAA;IAChB;;KAEC;IACD,eAAe,IAAA;IACf;;KAEC;IACD,aAAa,IAAA;IACb;;KAEC;IACD,cAAc,IAAA;IACd;;KAEC;IACD,gBAAgB,IAAA;IAChB;;KAEC;IACD,oBAAoB,IAAA;IACpB;;KAEC;IACD,0BAA0B,KAAA;IAC1B;;KAEC;IACD,iCAAiC,KAAA;IACjC;;KAEC;IACD,wBAAwB,KAAA;IACxB;;KAEC;IACD,YAAY,KAAA;IACZ;;KAEC;IACD,eAAe,KAAA;IACf;;KAEC;IACD,WAAW,KAAA;IACX;;KAEC;IACD,eAAe,KAAA;IACf;;KAEC;IACD,oBAAoB,KAAA;IACpB;;KAEC;IACD,aAAa,KAAA;CAChB;AAED,MAAM,WAAW,YAAY;IACzB;;KAEC;IACD,SAAS,EAAE,eAAe,CAAC;IAC3B;;KAEC;IACD,EAAE,EAAE,MAAM,CAAC;IACX;;KAEC;IACD,GAAG,EAAE,MAAM,CAAC;IACZ;;KAEC;IACD,IAAI,EAAE,MAAM,CAAC;IACb;;KAEC;IACD,UAAU,EAAE,OAAO,CAAC;IACpB;;KAEC;IACD,MAAM,EAAE,gBAAgB,CAAC;IACzB;;KAEC;IACD,SAAS,EAAE,OAAO,CAAC;IACnB;;KAEC;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB;;KAEC;IACD,WAAW,EAAE,MAAM,CAAC;IACpB;;KAEC;IACD,YAAY,EAAE,MAAM,CAAC;IACrB;;KAEC;IACD,KAAK,EAAE,MAAM,CAAC;IACd;;KAEC;IACD,UAAU,EAAE,MAAM,CAAC;IACnB;;KAEC;IACD,eAAe,EAAE,MAAM,CAAC;IACxB;;KAEC;IACD,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;KAEC;IACD,UAAU,EAAE,MAAM,CAAC;IACnB;;KAEC;IACD,UAAU,EAAE,MAAM,CAAC;IACnB;;KAEC;IACD,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,WAAW,EAAE,YAAY,CAAC;IAC1B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,kBAAkB,EAAE,MAAM,CAAC;CAC9B"}