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

package/commonjs/social/types.d.ts

@@ -0,0 +1,305 @@
+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/commonjs/social/types.d.ts.map

@@ -0,0 +1 @@
+{"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"}

package/commonjs/social/types.js

@@ -0,0 +1,210 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SocialStatusCode = exports.SocialFollowResult = exports.SocialActorTypes = exports.SocialActorType = exports.MySocial = exports._MySocial = exports.Social = exports._Social = void 0;
+const tslib_1 = require("tslib");
+const spqueryable_js_1 = require("../spqueryable.js");
+const decorators_js_1 = require("../decorators.js");
+const core_1 = require("@pnp/core");
+const queryable_1 = require("@pnp/queryable");
+let _Social = class _Social extends spqueryable_js_1._SPInstance {
+    get my() {
+        return (0, exports.MySocial)(this);
+    }
+    async getFollowedSitesUri() {
+        const r = await SocialCloneFactory(this, "FollowedSitesUri")();
+        return r.FollowedSitesUri || r;
+    }
+    async getFollowedDocumentsUri() {
+        const r = await SocialCloneFactory(this, "FollowedDocumentsUri")();
+        return r.FollowedDocumentsUri || r;
+    }
+    async follow(actorInfo) {
+        return (0, spqueryable_js_1.spPost)(SocialCloneFactory(this, "follow"), this.createSocialActorInfoRequestBody(actorInfo));
+    }
+    async isFollowed(actorInfo) {
+        return (0, spqueryable_js_1.spPost)(SocialCloneFactory(this, "isfollowed"), this.createSocialActorInfoRequestBody(actorInfo));
+    }
+    async stopFollowing(actorInfo) {
+        return (0, spqueryable_js_1.spPost)(SocialCloneFactory(this, "stopfollowing"), this.createSocialActorInfoRequestBody(actorInfo));
+    }
+    createSocialActorInfoRequestBody(actorInfo) {
+        return (0, queryable_1.body)({
+            "actor": {
+                Id: null,
+                ...actorInfo,
+            },
+        });
+    }
+};
+_Social = (0, tslib_1.__decorate)([
+    (0, decorators_js_1.defaultPath)("_api/social.following")
+], _Social);
+exports._Social = _Social;
+/**
+ * Get a new Social instance for the particular Url
+ */
+const Social = (baseUrl) => new _Social(baseUrl);
+exports.Social = Social;
+const SocialCloneFactory = (baseUrl, paths) => new _Social(baseUrl, paths);
+/**
+ * Current user's Social instance
+ */
+let _MySocial = class _MySocial extends spqueryable_js_1._SPInstance {
+    async followed(types) {
+        const r = await MySocialCloneFactory(this, `followed(types=${types})`)();
+        return (0, core_1.hOP)(r, "Followed") ? r.Followed.results : r;
+    }
+    async followedCount(types) {
+        const r = await MySocialCloneFactory(this, `followedcount(types=${types})`)();
+        return r.FollowedCount || r;
+    }
+    async followers() {
+        const r = await MySocialCloneFactory(this, "followers")();
+        return (0, core_1.hOP)(r, "Followers") ? r.Followers.results : r;
+    }
+    async suggestions() {
+        const r = await MySocialCloneFactory(this, "suggestions")();
+        return (0, core_1.hOP)(r, "Suggestions") ? r.Suggestions.results : r;
+    }
+};
+_MySocial = (0, tslib_1.__decorate)([
+    (0, decorators_js_1.defaultPath)("my")
+], _MySocial);
+exports._MySocial = _MySocial;
+/**
+ * Invokable factory for IMySocial instances
+ */
+const MySocial = (baseUrl, path) => new _MySocial(baseUrl, path);
+exports.MySocial = MySocial;
+const MySocialCloneFactory = (baseUrl, path) => new _MySocial(baseUrl, path);
+/**
+ * Social actor type
+ *
+ */
+var SocialActorType;
+(function (SocialActorType) {
+    SocialActorType[SocialActorType["User"] = 0] = "User";
+    SocialActorType[SocialActorType["Document"] = 1] = "Document";
+    SocialActorType[SocialActorType["Site"] = 2] = "Site";
+    SocialActorType[SocialActorType["Tag"] = 3] = "Tag";
+})(SocialActorType = exports.SocialActorType || (exports.SocialActorType = {}));
+/**
+ * Social actor type
+ *
+ */
+/* eslint-disable no-bitwise */
+var SocialActorTypes;
+(function (SocialActorTypes) {
+    SocialActorTypes[SocialActorTypes["None"] = 0] = "None";
+    SocialActorTypes[SocialActorTypes["User"] = 1] = "User";
+    SocialActorTypes[SocialActorTypes["Document"] = 2] = "Document";
+    SocialActorTypes[SocialActorTypes["Site"] = 4] = "Site";
+    SocialActorTypes[SocialActorTypes["Tag"] = 8] = "Tag";
+    /**
+   * The set excludes documents and sites that do not have feeds.
+   */
+    SocialActorTypes[SocialActorTypes["ExcludeContentWithoutFeeds"] = 268435456] = "ExcludeContentWithoutFeeds";
+    /**
+   * The set includes group sites
+   */
+    SocialActorTypes[SocialActorTypes["IncludeGroupsSites"] = 536870912] = "IncludeGroupsSites";
+    /**
+   * The set includes only items created within the last 24 hours
+   */
+    SocialActorTypes[SocialActorTypes["WithinLast24Hours"] = 1073741824] = "WithinLast24Hours";
+})(SocialActorTypes = exports.SocialActorTypes || (exports.SocialActorTypes = {}));
+/* eslint-enable no-bitwise */
+/**
+ * Result from following
+ *
+ */
+var SocialFollowResult;
+(function (SocialFollowResult) {
+    SocialFollowResult[SocialFollowResult["Ok"] = 0] = "Ok";
+    SocialFollowResult[SocialFollowResult["AlreadyFollowing"] = 1] = "AlreadyFollowing";
+    SocialFollowResult[SocialFollowResult["LimitReached"] = 2] = "LimitReached";
+    SocialFollowResult[SocialFollowResult["InternalError"] = 3] = "InternalError";
+})(SocialFollowResult = exports.SocialFollowResult || (exports.SocialFollowResult = {}));
+/**
+ * Specifies an exception or status code.
+ */
+var SocialStatusCode;
+(function (SocialStatusCode) {
+    /**
+   * The operation completed successfully
+   */
+    SocialStatusCode[SocialStatusCode["OK"] = 0] = "OK";
+    /**
+   * The request is invalid.
+   */
+    SocialStatusCode[SocialStatusCode["InvalidRequest"] = 1] = "InvalidRequest";
+    /**
+   *  The current user is not authorized to perform the operation.
+   */
+    SocialStatusCode[SocialStatusCode["AccessDenied"] = 2] = "AccessDenied";
+    /**
+   * The target of the operation was not found.
+   */
+    SocialStatusCode[SocialStatusCode["ItemNotFound"] = 3] = "ItemNotFound";
+    /**
+   * The operation is invalid for the target's current state.
+   */
+    SocialStatusCode[SocialStatusCode["InvalidOperation"] = 4] = "InvalidOperation";
+    /**
+   * The operation completed without modifying the target.
+   */
+    SocialStatusCode[SocialStatusCode["ItemNotModified"] = 5] = "ItemNotModified";
+    /**
+   * The operation failed because an internal error occurred.
+   */
+    SocialStatusCode[SocialStatusCode["InternalError"] = 6] = "InternalError";
+    /**
+   * The operation failed because the server could not access the distributed cache.
+   */
+    SocialStatusCode[SocialStatusCode["CacheReadError"] = 7] = "CacheReadError";
+    /**
+   * The operation succeeded but the server could not update the distributed cache.
+   */
+    SocialStatusCode[SocialStatusCode["CacheUpdateError"] = 8] = "CacheUpdateError";
+    /**
+   * No personal site exists for the current user, and no further information is available.
+   */
+    SocialStatusCode[SocialStatusCode["PersonalSiteNotFound"] = 9] = "PersonalSiteNotFound";
+    /**
+   * No personal site exists for the current user, and a previous attempt to create one failed.
+   */
+    SocialStatusCode[SocialStatusCode["FailedToCreatePersonalSite"] = 10] = "FailedToCreatePersonalSite";
+    /**
+   * No personal site exists for the current user, and a previous attempt to create one was not authorized.
+   */
+    SocialStatusCode[SocialStatusCode["NotAuthorizedToCreatePersonalSite"] = 11] = "NotAuthorizedToCreatePersonalSite";
+    /**
+   * No personal site exists for the current user, and no attempt should be made to create one.
+   */
+    SocialStatusCode[SocialStatusCode["CannotCreatePersonalSite"] = 12] = "CannotCreatePersonalSite";
+    /**
+   * The operation was rejected because an internal limit had been reached.
+   */
+    SocialStatusCode[SocialStatusCode["LimitReached"] = 13] = "LimitReached";
+    /**
+   * The operation failed because an error occurred during the processing of the specified attachment.
+   */
+    SocialStatusCode[SocialStatusCode["AttachmentError"] = 14] = "AttachmentError";
+    /**
+   * The operation succeeded with recoverable errors; the returned data is incomplete.
+   */
+    SocialStatusCode[SocialStatusCode["PartialData"] = 15] = "PartialData";
+    /**
+   * A required SharePoint feature is not enabled.
+   */
+    SocialStatusCode[SocialStatusCode["FeatureDisabled"] = 16] = "FeatureDisabled";
+    /**
+   * The site's storage quota has been exceeded.
+   */
+    SocialStatusCode[SocialStatusCode["StorageQuotaExceeded"] = 17] = "StorageQuotaExceeded";
+    /**
+   * The operation failed because the server could not access the database.
+   */
+    SocialStatusCode[SocialStatusCode["DatabaseError"] = 18] = "DatabaseError";
+})(SocialStatusCode = exports.SocialStatusCode || (exports.SocialStatusCode = {}));
+//# sourceMappingURL=types.js.map

package/commonjs/social/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/sp/social/types.ts"],"names":[],"mappings":";;;;AAAA,sDAK2B;AAC3B,oDAA+C;AAC/C,oCAAgC;AAChC,8CAAsC;AAGtC,IAAa,OAAO,GAApB,MAAa,OAAQ,SAAQ,4BAAW;IAEpC,IAAW,EAAE;QACT,OAAO,IAAA,gBAAQ,EAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAEM,KAAK,CAAC,mBAAmB;QAC5B,MAAM,CAAC,GAAG,MAAM,kBAAkB,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,CAAC;QAC/D,OAAO,CAAC,CAAC,gBAAgB,IAAI,CAAC,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,uBAAuB;QAChC,MAAM,CAAC,GAAG,MAAM,kBAAkB,CAAC,IAAI,EAAE,sBAAsB,CAAC,EAAE,CAAC;QACnE,OAAO,CAAC,CAAC,oBAAoB,IAAI,CAAC,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAA2B;QAC3C,OAAO,IAAA,uBAAM,EAAC,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,gCAAgC,CAAC,SAAS,CAAC,CAAC,CAAC;IACxG,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,SAA2B;QAC/C,OAAO,IAAA,uBAAM,EAAC,kBAAkB,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,IAAI,CAAC,gCAAgC,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5G,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,SAA2B;QAClD,OAAO,IAAA,uBAAM,EAAC,kBAAkB,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,IAAI,CAAC,gCAAgC,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/G,CAAC;IAEO,gCAAgC,CAAC,SAA2B;QAChE,OAAO,IAAA,gBAAI,EAAC;YACR,OAAO,EAAE;gBACL,EAAE,EAAE,IAAI;gBACR,GAAG,SAAS;aACf;SACJ,CAAC,CAAC;IACP,CAAC;CACJ,CAAA;AApCY,OAAO;IADnB,IAAA,2BAAW,EAAC,uBAAuB,CAAC;GACxB,OAAO,CAoCnB;AApCY,0BAAO;AAsCpB;;GAEG;AACI,MAAM,MAAM,GAAG,CAAC,OAAe,EAAW,EAAE,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;AAA5D,QAAA,MAAM,UAAsD;AACzE,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAE,KAAc,EAA0B,EAAE,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAEpH;;GAEG;AAEH,IAAa,SAAS,GAAtB,MAAa,SAAU,SAAQ,4BAAW;IAG/B,KAAK,CAAC,QAAQ,CAAC,KAAuB;QACzC,MAAM,CAAC,GAAG,MAAM,oBAAoB,CAAC,IAAI,EAAE,kBAAkB,KAAK,GAAG,CAAC,EAAE,CAAC;QACzE,OAAO,IAAA,UAAG,EAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;IAGM,KAAK,CAAC,aAAa,CAAC,KAAuB;QAC9C,MAAM,CAAC,GAAG,MAAM,oBAAoB,CAAC,IAAI,EAAE,uBAAuB,KAAK,GAAG,CAAC,EAAE,CAAC;QAC9E,OAAO,CAAC,CAAC,aAAa,IAAI,CAAC,CAAC;IAChC,CAAC;IAGM,KAAK,CAAC,SAAS;QAClB,MAAM,CAAC,GAAG,MAAM,oBAAoB,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC;QAC1D,OAAO,IAAA,UAAG,EAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IAGM,KAAK,CAAC,WAAW;QACpB,MAAM,CAAC,GAAG,MAAM,oBAAoB,CAAC,IAAI,EAAE,aAAa,CAAC,EAAE,CAAC;QAC5D,OAAO,IAAA,UAAG,EAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7D,CAAC;CACJ,CAAA;AAzBY,SAAS;IADrB,IAAA,2BAAW,EAAC,IAAI,CAAC;GACL,SAAS,CAyBrB;AAzBY,8BAAS;AA2BtB;;GAEG;AACI,MAAM,QAAQ,GAAG,CAAC,OAA8B,EAAE,IAAa,EAAa,EAAE,CAAC,IAAI,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAAtG,QAAA,QAAQ,YAA8F;AACnH,MAAM,oBAAoB,GAAG,CAAC,OAA8B,EAAE,IAAa,EAA4B,EAAE,CAAC,IAAI,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAkFvI;;;GAGG;AACH,IAAkB,eAKjB;AALD,WAAkB,eAAe;IAC7B,qDAAI,CAAA;IACJ,6DAAQ,CAAA;IACR,qDAAI,CAAA;IACJ,mDAAG,CAAA;AACP,CAAC,EALiB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAKhC;AAED;;;GAGG;AACH,+BAA+B;AAC/B,IAAkB,gBAkBjB;AAlBD,WAAkB,gBAAgB;IAC9B,uDAAQ,CAAA;IACR,uDAAgC,CAAA;IAChC,+DAAwC,CAAA;IACxC,uDAAgC,CAAA;IAChC,qDAA8B,CAAA;IAC9B;;KAEC;IACD,2GAAsC,CAAA;IACtC;;KAEC;IACD,2FAA8B,CAAA;IAC9B;;KAEC;IACD,0FAA8B,CAAA;AAClC,CAAC,EAlBiB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAkBjC;AACD,8BAA8B;AAE9B;;;GAGG;AACH,IAAkB,kBAKjB;AALD,WAAkB,kBAAkB;IAChC,uDAAM,CAAA;IACN,mFAAoB,CAAA;IACpB,2EAAgB,CAAA;IAChB,6EAAiB,CAAA;AACrB,CAAC,EALiB,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAKnC;AAED;;GAEG;AACH,IAAkB,gBA6EjB;AA7ED,WAAkB,gBAAgB;IAC9B;;KAEC;IACD,mDAAE,CAAA;IACF;;KAEC;IACD,2EAAc,CAAA;IACd;;KAEC;IACD,uEAAY,CAAA;IACZ;;KAEC;IACD,uEAAY,CAAA;IACZ;;KAEC;IACD,+EAAgB,CAAA;IAChB;;KAEC;IACD,6EAAe,CAAA;IACf;;KAEC;IACD,yEAAa,CAAA;IACb;;KAEC;IACD,2EAAc,CAAA;IACd;;KAEC;IACD,+EAAgB,CAAA;IAChB;;KAEC;IACD,uFAAoB,CAAA;IACpB;;KAEC;IACD,oGAA0B,CAAA;IAC1B;;KAEC;IACD,kHAAiC,CAAA;IACjC;;KAEC;IACD,gGAAwB,CAAA;IACxB;;KAEC;IACD,wEAAY,CAAA;IACZ;;KAEC;IACD,8EAAe,CAAA;IACf;;KAEC;IACD,sEAAW,CAAA;IACX;;KAEC;IACD,8EAAe,CAAA;IACf;;KAEC;IACD,wFAAoB,CAAA;IACpB;;KAEC;IACD,0EAAa,CAAA;AACjB,CAAC,EA7EiB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QA6EjC"}

package/commonjs/spqueryable.d.ts

@@ -0,0 +1,117 @@
+import { IInvokable, Queryable } from "@pnp/queryable";
+export declare type SPInit = string | ISPQueryable | [ISPQueryable, string];
+export interface ISPConstructor<T extends ISPQueryable = ISPQueryable> {
+    new (base: SPInit, path?: string): T;
+}
+export declare type ISPInvokableFactory<R extends ISPQueryable> = (base: SPInit, path?: string) => R & IInvokable;
+export declare const spInvokableFactory: <R extends ISPQueryable<any>>(f: any) => ISPInvokableFactory<R>;
+/**
+ * SharePointQueryable Base Class
+ *
+ */
+export declare class _SPQueryable<GetType = any> extends Queryable<GetType> {
+    protected parentUrl: string;
+    /**
+     * Creates a new instance of the SharePointQueryable class
+     *
+     * @constructor
+     * @param base A string or SharePointQueryable that should form the base part of the url
+     *
+     */
+    constructor(base: SPInit, path?: string);
+    /**
+     * Gets the full url with query information
+     */
+    toRequestUrl(): string;
+    /**
+     * Choose which fields to return
+     *
+     * @param selects One or more fields to return
+     */
+    select(...selects: string[]): this;
+    /**
+     * Expands fields such as lookups to get additional data
+     *
+     * @param expands The Fields for which to expand the values
+     */
+    expand(...expands: string[]): this;
+    /**
+     * Gets a parent for this instance as specified
+     *
+     * @param factory The contructor for the class to create
+     */
+    protected getParent<T extends ISPQueryable>(factory: ISPInvokableFactory<any>, path?: string, base?: string): T;
+}
+export interface ISPQueryable<GetType = any> extends _SPQueryable<GetType> {
+}
+export declare const SPQueryable: ISPInvokableFactory<ISPQueryable<any>>;
+/**
+ * Represents a REST collection which can be filtered, paged, and selected
+ *
+ */
+export declare class _SPCollection<GetType = any[]> extends _SPQueryable<GetType> {
+    /**
+     * Filters the returned collection (https://msdn.microsoft.com/en-us/library/office/fp142385.aspx#bk_supported)
+     *
+     * @param filter The string representing the filter query
+     */
+    filter(filter: string): this;
+    /**
+     * Orders based on the supplied fields
+     *
+     * @param orderby The name of the field on which to sort
+     * @param ascending If false DESC is appended, otherwise ASC (default)
+     */
+    orderBy(orderBy: string, ascending?: boolean): this;
+    /**
+     * Skips the specified number of items
+     *
+     * @param skip The number of items to skip
+     */
+    skip(skip: number): this;
+    /**
+     * Limits the query to only return the specified number of items
+     *
+     * @param top The query row limit
+     */
+    top(top: number): this;
+}
+export interface ISPCollection<GetType = any[]> extends _SPCollection<GetType> {
+}
+export declare const SPCollection: ISPInvokableFactory<ISPCollection<any[]>>;
+/**
+ * Represents an instance that can be selected
+ *
+ */
+export declare class _SPInstance<GetType = any> extends _SPQueryable<GetType> {
+}
+export interface ISPInstance<GetType = any> extends _SPInstance<GetType> {
+}
+export declare const SPInstance: ISPInvokableFactory<ISPInstance<any>>;
+/**
+ * Adds the a delete method to the tagged class taking no parameters and calling spPostDelete
+ */
+export declare function deleteable(): (this: ISPQueryable) => Promise<void>;
+export interface IDeleteable {
+    /**
+     * Delete this instance
+     */
+    delete(): Promise<void>;
+}
+export declare function deleteableWithETag(): (this: ISPQueryable, eTag?: string) => Promise<void>;
+export interface IDeleteableWithETag {
+    /**
+     * Delete this instance
+     *
+     * @param eTag Value used in the IF-Match header, by default "*"
+     */
+    delete(eTag?: string): Promise<void>;
+}
+export declare const spGet: <T = any>(o: ISPQueryable<any>, init?: RequestInit) => Promise<T>;
+export declare const spPost: <T = any>(o: ISPQueryable<any>, init?: RequestInit) => Promise<T>;
+export declare const spPostMerge: <T = any>(o: ISPQueryable<any>, init?: RequestInit) => Promise<T>;
+export declare const spPostDelete: <T = any>(o: ISPQueryable<any>, init?: RequestInit) => Promise<T>;
+export declare const spPostDeleteETag: <T = any>(o: ISPQueryable<any>, init?: RequestInit, eTag?: string) => Promise<T>;
+export declare const spDelete: <T = any>(o: ISPQueryable<any>, init?: RequestInit) => Promise<T>;
+export declare const spPatch: <T = any>(o: ISPQueryable<any>, init?: RequestInit) => Promise<T>;
+//# sourceMappingURL=spqueryable.d.ts.map

package/commonjs/spqueryable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"spqueryable.d.ts","sourceRoot":"","sources":["../../../../packages/sp/spqueryable.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,SAAS,EAA+C,MAAM,gBAAgB,CAAC;AAEpG,oBAAY,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;AAEpE,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY;IACjE,KAAI,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC;CACvC;AAED,oBAAY,mBAAmB,CAAC,CAAC,SAAS,YAAY,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,CAAC,GAAG,UAAU,CAAC;AAE1G,eAAO,MAAM,kBAAkB,mCAA+B,GAAG,2BAEhE,CAAC;AAEF;;;GAGG;AACH,qBAAa,YAAY,CAAC,OAAO,GAAG,GAAG,CAAE,SAAQ,SAAS,CAAC,OAAO,CAAC;IAE/D,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAE5B;;;;;;OAMG;gBACS,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IA6CvC;;OAEG;IACI,YAAY,IAAI,MAAM;IAyB7B;;;;OAIG;IACI,MAAM,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAOzC;;;;OAIG;IACI,MAAM,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAOzC;;;;OAIG;IACH,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,YAAY,EACtC,OAAO,EAAE,mBAAmB,CAAC,GAAG,CAAC,EACjC,IAAI,CAAC,EAAE,MAAM,EACb,IAAI,GAAE,MAAuB,GAAG,CAAC;CAWxC;AACD,MAAM,WAAW,YAAY,CAAC,OAAO,GAAG,GAAG,CAAE,SAAQ,YAAY,CAAC,OAAO,CAAC;CAAI;AAC9E,eAAO,MAAM,WAAW,wCAAiD,CAAC;AAE1E;;;GAGG;AACH,qBAAa,aAAa,CAAC,OAAO,GAAG,GAAG,EAAE,CAAE,SAAQ,YAAY,CAAC,OAAO,CAAC;IAErE;;;;OAIG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKnC;;;;;OAKG;IACI,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,IAAI;IAQvD;;;;OAIG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK/B;;;;OAIG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAIhC;AACD,MAAM,WAAW,aAAa,CAAC,OAAO,GAAG,GAAG,EAAE,CAAE,SAAQ,aAAa,CAAC,OAAO,CAAC;CAAI;AAClF,eAAO,MAAM,YAAY,2CAAmD,CAAC;AAE7E;;;GAGG;AACH,qBAAa,WAAW,CAAC,OAAO,GAAG,GAAG,CAAE,SAAQ,YAAY,CAAC,OAAO,CAAC;CAAI;AACzE,MAAM,WAAW,WAAW,CAAC,OAAO,GAAG,GAAG,CAAE,SAAQ,WAAW,CAAC,OAAO,CAAC;CAAI;AAC5E,eAAO,MAAM,UAAU,uCAA+C,CAAC;AAEvE;;GAEG;AACH,wBAAgB,UAAU,WAEC,YAAY,KAAG,QAAQ,IAAI,CAAC,CAGtD;AAED,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED,wBAAgB,kBAAkB,WAEP,YAAY,oBAAe,QAAQ,IAAI,CAAC,CAGlE;AAED,MAAM,WAAW,mBAAmB;IAChC;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACxC;AAED,eAAO,MAAM,KAAK,eAAgB,aAAa,GAAG,CAAC,SAAS,WAAW,eAEtE,CAAC;AAEF,eAAO,MAAM,MAAM,eAAgB,aAAa,GAAG,CAAC,SAAS,WAAW,eAAkC,CAAC;AAE3G,eAAO,MAAM,WAAW,eAAgB,aAAa,GAAG,CAAC,SAAS,WAAW,eAK5E,CAAC;AAEF,eAAO,MAAM,YAAY,eAAgB,aAAa,GAAG,CAAC,SAAS,WAAW,eAK7E,CAAC;AAEF,eAAO,MAAM,gBAAgB,eAAgB,aAAa,GAAG,CAAC,SAAS,WAAW,8BAKjF,CAAC;AAEF,eAAO,MAAM,QAAQ,eAAgB,aAAa,GAAG,CAAC,SAAS,WAAW,eAAiC,CAAC;AAE5G,eAAO,MAAM,OAAO,eAAgB,aAAa,GAAG,CAAC,SAAS,WAAW,eAAmC,CAAC"}