@pnp/sp 3.21.0-v3nightly.20240111 → 3.21.0-v4nightly.20240115

package/esm/social/types.js

@@ -0,0 +1,205 @@
+import { __decorate } from "tslib";
+import { _SPInstance, spPost, } from "../spqueryable.js";
+import { defaultPath } from "../decorators.js";
+import { hOP } from "@pnp/core";
+import { body } from "@pnp/queryable";
+let _Social = class _Social extends _SPInstance {
+    get my() {
+        return 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 spPost(SocialCloneFactory(this, "follow"), this.createSocialActorInfoRequestBody(actorInfo));
+    }
+    async isFollowed(actorInfo) {
+        return spPost(SocialCloneFactory(this, "isfollowed"), this.createSocialActorInfoRequestBody(actorInfo));
+    }
+    async stopFollowing(actorInfo) {
+        return spPost(SocialCloneFactory(this, "stopfollowing"), this.createSocialActorInfoRequestBody(actorInfo));
+    }
+    createSocialActorInfoRequestBody(actorInfo) {
+        return body({
+            "actor": {
+                Id: null,
+                ...actorInfo,
+            },
+        });
+    }
+};
+_Social = __decorate([
+    defaultPath("_api/social.following")
+], _Social);
+export { _Social };
+/**
+ * Get a new Social instance for the particular Url
+ */
+export const Social = (baseUrl) => new _Social(baseUrl);
+const SocialCloneFactory = (baseUrl, paths) => new _Social(baseUrl, paths);
+/**
+ * Current user's Social instance
+ */
+let _MySocial = class _MySocial extends _SPInstance {
+    async followed(types) {
+        const r = await MySocialCloneFactory(this, `followed(types=${types})`)();
+        return 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 hOP(r, "Followers") ? r.Followers.results : r;
+    }
+    async suggestions() {
+        const r = await MySocialCloneFactory(this, "suggestions")();
+        return hOP(r, "Suggestions") ? r.Suggestions.results : r;
+    }
+};
+_MySocial = __decorate([
+    defaultPath("my")
+], _MySocial);
+export { _MySocial };
+/**
+ * Invokable factory for IMySocial instances
+ */
+export const MySocial = (baseUrl, path) => new _MySocial(baseUrl, path);
+const MySocialCloneFactory = (baseUrl, path) => new _MySocial(baseUrl, path);
+/**
+ * Social actor type
+ *
+ */
+export 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 || (SocialActorType = {}));
+/**
+ * Social actor type
+ *
+ */
+/* eslint-disable no-bitwise */
+export 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 || (SocialActorTypes = {}));
+/* eslint-enable no-bitwise */
+/**
+ * Result from following
+ *
+ */
+export 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 || (SocialFollowResult = {}));
+/**
+ * Specifies an exception or status code.
+ */
+export 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 || (SocialStatusCode = {}));
+//# sourceMappingURL=types.js.map

package/esm/social/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../packages/sp/social/types.ts"],"names":[],"mappings":";AAAA,OAAO,EACH,WAAW,EAGX,MAAM,GACT,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAGtC,IAAa,OAAO,GAApB,MAAa,OAAQ,SAAQ,WAAW;IAEpC,IAAW,EAAE;QACT,OAAO,QAAQ,CAAC,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,MAAM,CAAC,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,MAAM,CAAC,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,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,IAAI,CAAC,gCAAgC,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/G,CAAC;IAEO,gCAAgC,CAAC,SAA2B;QAChE,OAAO,IAAI,CAAC;YACR,OAAO,EAAE;gBACL,EAAE,EAAE,IAAI;gBACR,GAAG,SAAS;aACf;SACJ,CAAC,CAAC;IACP,CAAC;CACJ,CAAA;AApCY,OAAO;IADnB,WAAW,CAAC,uBAAuB,CAAC;GACxB,OAAO,CAoCnB;SApCY,OAAO;AAsCpB;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,OAAe,EAAW,EAAE,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;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,WAAW;IAG/B,KAAK,CAAC,QAAQ,CAAC,KAAuB;QACzC,MAAM,CAAC,GAAG,MAAM,oBAAoB,CAAC,IAAI,EAAE,kBAAkB,KAAK,GAAG,CAAC,EAAE,CAAC;QACzE,OAAO,GAAG,CAAC,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,GAAG,CAAC,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,GAAG,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7D,CAAC;CACJ,CAAA;AAzBY,SAAS;IADrB,WAAW,CAAC,IAAI,CAAC;GACL,SAAS,CAyBrB;SAzBY,SAAS;AA2BtB;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,OAA8B,EAAE,IAAa,EAAa,EAAE,CAAC,IAAI,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AACnH,MAAM,oBAAoB,GAAG,CAAC,OAA8B,EAAE,IAAa,EAA4B,EAAE,CAAC,IAAI,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AAkFvI;;;GAGG;AACH,MAAM,CAAN,IAAkB,eAKjB;AALD,WAAkB,eAAe;IAC7B,qDAAI,CAAA;IACJ,6DAAQ,CAAA;IACR,qDAAI,CAAA;IACJ,mDAAG,CAAA;AACP,CAAC,EALiB,eAAe,KAAf,eAAe,QAKhC;AAED;;;GAGG;AACH,+BAA+B;AAC/B,MAAM,CAAN,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,KAAhB,gBAAgB,QAkBjC;AACD,8BAA8B;AAE9B;;;GAGG;AACH,MAAM,CAAN,IAAkB,kBAKjB;AALD,WAAkB,kBAAkB;IAChC,uDAAM,CAAA;IACN,mFAAoB,CAAA;IACpB,2EAAgB,CAAA;IAChB,6EAAiB,CAAA;AACrB,CAAC,EALiB,kBAAkB,KAAlB,kBAAkB,QAKnC;AAED;;GAEG;AACH,MAAM,CAAN,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,KAAhB,gBAAgB,QA6EjC"}

package/esm/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/esm/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"}

package/esm/spqueryable.js

@@ -0,0 +1,203 @@
+import { combine, isUrlAbsolute, isArray, objectDefinedNotNull, stringIsNullOrEmpty } from "@pnp/core";
+import { Queryable, queryableFactory, op, get, post, patch, del } from "@pnp/queryable";
+export const spInvokableFactory = (f) => {
+    return queryableFactory(f);
+};
+/**
+ * SharePointQueryable Base Class
+ *
+ */
+export class _SPQueryable extends Queryable {
+    /**
+     * 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, path) {
+        if (typeof base === "string") {
+            let url = "";
+            let parentUrl = "";
+            // we need to do some extra parsing to get the parent url correct if we are
+            // being created from just a string.
+            if (isUrlAbsolute(base) || base.lastIndexOf("/") < 0) {
+                parentUrl = base;
+                url = combine(base, path);
+            }
+            else if (base.lastIndexOf("/") > base.lastIndexOf("(")) {
+                // .../items(19)/fields
+                const index = base.lastIndexOf("/");
+                parentUrl = base.slice(0, index);
+                path = combine(base.slice(index), path);
+                url = combine(parentUrl, path);
+            }
+            else {
+                // .../items(19)
+                const index = base.lastIndexOf("(");
+                parentUrl = base.slice(0, index);
+                url = combine(base, path);
+            }
+            // init base with corrected string value
+            super(url);
+            this.parentUrl = parentUrl;
+        }
+        else {
+            super(base, path);
+            const q = isArray(base) ? base[0] : base;
+            this.parentUrl = isArray(base) ? base[1] : q.toUrl();
+            const target = q.query.get("@target");
+            if (objectDefinedNotNull(target)) {
+                this.query.set("@target", target);
+            }
+        }
+    }
+    /**
+     * Gets the full url with query information
+     */
+    toRequestUrl() {
+        const aliasedParams = new URLSearchParams(this.query);
+        // this regex is designed to locate aliased parameters within url paths. These may have the form:
+        // /something(!@p1::value)
+        // /something(!@p1::value, param=value)
+        // /something(param=value,!@p1::value)
+        // /something(param=value,!@p1::value,param=value)
+        // /something(param=!@p1::value)
+        // there could be spaces or not around the boundaries
+        let url = this.toUrl().replace(/([( *| *, *| *= *])'!(@.*?)::(.*?)'([ *)| *, *])/ig, (match, frontBoundary, labelName, value, endBoundary) => {
+            this.log(`Rewriting aliased parameter from match ${match} to label: ${labelName} value: ${value}`, 0);
+            aliasedParams.set(labelName, `'${value}'`);
+            return `${frontBoundary}${labelName}${endBoundary}`;
+        });
+        const query = aliasedParams.toString();
+        if (!stringIsNullOrEmpty(query)) {
+            url += `${url.indexOf("?") > -1 ? "&" : "?"}${query}`;
+        }
+        return url;
+    }
+    /**
+     * Choose which fields to return
+     *
+     * @param selects One or more fields to return
+     */
+    select(...selects) {
+        if (selects.length > 0) {
+            this.query.set("$select", selects.join(","));
+        }
+        return this;
+    }
+    /**
+     * Expands fields such as lookups to get additional data
+     *
+     * @param expands The Fields for which to expand the values
+     */
+    expand(...expands) {
+        if (expands.length > 0) {
+            this.query.set("$expand", expands.join(","));
+        }
+        return this;
+    }
+    /**
+     * Gets a parent for this instance as specified
+     *
+     * @param factory The contructor for the class to create
+     */
+    getParent(factory, path, base = this.parentUrl) {
+        const parent = factory([this, base], path);
+        const t = "@target";
+        if (this.query.has(t)) {
+            parent.query.set(t, this.query.get(t));
+        }
+        return parent;
+    }
+}
+export const SPQueryable = spInvokableFactory(_SPQueryable);
+/**
+ * Represents a REST collection which can be filtered, paged, and selected
+ *
+ */
+export class _SPCollection extends _SPQueryable {
+    /**
+     * 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) {
+        this.query.set("$filter", filter);
+        return 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, ascending = true) {
+        const o = "$orderby";
+        const query = this.query.has(o) ? this.query.get(o).split(",") : [];
+        query.push(`${orderBy} ${ascending ? "asc" : "desc"}`);
+        this.query.set(o, query.join(","));
+        return this;
+    }
+    /**
+     * Skips the specified number of items
+     *
+     * @param skip The number of items to skip
+     */
+    skip(skip) {
+        this.query.set("$skip", skip.toString());
+        return this;
+    }
+    /**
+     * Limits the query to only return the specified number of items
+     *
+     * @param top The query row limit
+     */
+    top(top) {
+        this.query.set("$top", top.toString());
+        return this;
+    }
+}
+export const SPCollection = spInvokableFactory(_SPCollection);
+/**
+ * Represents an instance that can be selected
+ *
+ */
+export class _SPInstance extends _SPQueryable {
+}
+export const SPInstance = spInvokableFactory(_SPInstance);
+/**
+ * Adds the a delete method to the tagged class taking no parameters and calling spPostDelete
+ */
+export function deleteable() {
+    return function () {
+        return spPostDelete(this);
+    };
+}
+export function deleteableWithETag() {
+    return function (eTag = "*") {
+        return spPostDeleteETag(this, {}, eTag);
+    };
+}
+export const spGet = (o, init) => {
+    return op(o, get, init);
+};
+export const spPost = (o, init) => op(o, post, init);
+export const spPostMerge = (o, init) => {
+    init = init || {};
+    init.headers = { ...init.headers, "X-HTTP-Method": "MERGE" };
+    return spPost(o, init);
+};
+export const spPostDelete = (o, init) => {
+    init = init || {};
+    init.headers = { ...init.headers || {}, "X-HTTP-Method": "DELETE" };
+    return spPost(o, init);
+};
+export const spPostDeleteETag = (o, init, eTag = "*") => {
+    init = init || {};
+    init.headers = { ...init.headers || {}, "IF-Match": eTag };
+    return spPostDelete(o, init);
+};
+export const spDelete = (o, init) => op(o, del, init);
+export const spPatch = (o, init) => op(o, patch, init);
+//# sourceMappingURL=spqueryable.js.map

package/esm/spqueryable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spqueryable.js","sourceRoot":"","sources":["../../../../packages/sp/spqueryable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AACvG,OAAO,EAAc,SAAS,EAAE,gBAAgB,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAUpG,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAyB,CAAM,EAA0B,EAAE;IACzF,OAAO,gBAAgB,CAAI,CAAC,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,OAAO,YAA4B,SAAQ,SAAkB;IAI/D;;;;;;OAMG;IACH,YAAY,IAAY,EAAE,IAAa;QAEnC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAE1B,IAAI,GAAG,GAAG,EAAE,CAAC;YACb,IAAI,SAAS,GAAG,EAAE,CAAC;YAEnB,2EAA2E;YAC3E,oCAAoC;YAEpC,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;gBAClD,SAAS,GAAG,IAAI,CAAC;gBACjB,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;aAC7B;iBAAM,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;gBACtD,uBAAuB;gBACvB,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBACpC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACjC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;gBACxC,GAAG,GAAG,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;aAClC;iBAAM;gBACH,gBAAgB;gBAChB,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBACpC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACjC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;aAC7B;YAED,wCAAwC;YACxC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEX,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;SAE9B;aAAM;YAEH,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAElB,MAAM,CAAC,GAAmB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACzD,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YAErD,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACtC,IAAI,oBAAoB,CAAC,MAAM,CAAC,EAAE;gBAC9B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;aACrC;SACJ;IACL,CAAC;IAED;;OAEG;IACI,YAAY;QAEf,MAAM,aAAa,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEtD,iGAAiG;QACjG,0BAA0B;QAC1B,uCAAuC;QACvC,sCAAsC;QACtC,kDAAkD;QAClD,gCAAgC;QAChC,qDAAqD;QACrD,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,oDAAoD,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE;YACzI,IAAI,CAAC,GAAG,CAAC,0CAA0C,KAAK,cAAc,SAAS,WAAW,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;YACtG,aAAa,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,KAAK,GAAG,CAAC,CAAC;YAC3C,OAAO,GAAG,aAAa,GAAG,SAAS,GAAG,WAAW,EAAE,CAAC;QACxD,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC;QACvC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE;YAC7B,GAAG,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,EAAE,CAAC;SACzD;QAED,OAAO,GAAG,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,GAAG,OAAiB;QAC9B,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACpB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;SAChD;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,GAAG,OAAiB;QAC9B,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACpB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;SAChD;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACO,SAAS,CACf,OAAiC,EACjC,IAAa,EACb,OAAe,IAAI,CAAC,SAAS;QAE7B,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;QAE3C,MAAM,CAAC,GAAG,SAAS,CAAC;QACpB,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACnB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1C;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,WAAW,GAAG,kBAAkB,CAAe,YAAY,CAAC,CAAC;AAE1E;;;GAGG;AACH,MAAM,OAAO,aAA+B,SAAQ,YAAqB;IAErE;;;;OAIG;IACI,MAAM,CAAC,MAAc;QACxB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,OAAe,EAAE,SAAS,GAAG,IAAI;QAC5C,MAAM,CAAC,GAAG,UAAU,CAAC;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACpE,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,IAAY;QACpB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,GAAG,CAAC,GAAW;QAClB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,kBAAkB,CAAgB,aAAa,CAAC,CAAC;AAE7E;;;GAGG;AACH,MAAM,OAAO,WAA2B,SAAQ,YAAqB;CAAI;AAEzE,MAAM,CAAC,MAAM,UAAU,GAAG,kBAAkB,CAAc,WAAW,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,UAAU,UAAU;IAEtB,OAAO;QACH,OAAO,YAAY,CAAO,IAAI,CAAC,CAAC;IACpC,CAAC,CAAC;AACN,CAAC;AASD,MAAM,UAAU,kBAAkB;IAE9B,OAAO,UAA8B,IAAI,GAAG,GAAG;QAC3C,OAAO,gBAAgB,CAAO,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC,CAAC;AACN,CAAC;AAWD,MAAM,CAAC,MAAM,KAAK,GAAG,CAAU,CAAoB,EAAE,IAAkB,EAAc,EAAE;IACnF,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,CAAU,CAAoB,EAAE,IAAkB,EAAc,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAE3G,MAAM,CAAC,MAAM,WAAW,GAAG,CAAU,CAAoB,EAAE,IAAkB,EAAc,EAAE;IACzF,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,CAAC;IAE7D,OAAO,MAAM,CAAI,CAAC,EAAE,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAU,CAAoB,EAAE,IAAkB,EAAc,EAAE;IAC1F,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC;IAEpE,OAAO,MAAM,CAAI,CAAC,EAAE,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAU,CAAoB,EAAE,IAAkB,EAAE,IAAI,GAAG,GAAG,EAAc,EAAE;IAC1G,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IAE3D,OAAO,YAAY,CAAI,CAAC,EAAE,IAAI,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAU,CAAoB,EAAE,IAAkB,EAAc,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;AAE5G,MAAM,CAAC,MAAM,OAAO,GAAG,CAAU,CAAoB,EAAE,IAAkB,EAAc,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC"}

package/esm/sputilities/index.d.ts

@@ -0,0 +1,8 @@
+import { IUtilities } from "./types.js";
+export { IEmailProperties, IUtilities, IWikiPageCreationInfo, Utilities, } from "./types.js";
+declare module "../fi" {
+    interface SPFI {
+        readonly utility: IUtilities;
+    }
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/sputilities/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAa,MAAM,YAAY,CAAC;AAEnD,OAAO,EACH,gBAAgB,EAChB,UAAU,EACV,qBAAqB,EACrB,SAAS,GACZ,MAAM,YAAY,CAAC;AAEpB,OAAO,QAAQ,OAAO,CAAC;IACnB,UAAU,IAAI;QACV,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;KAChC;CACJ"}

package/esm/sputilities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/sp/sputilities/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,OAAO,EAAc,SAAS,EAAE,MAAM,YAAY,CAAC;AAEnD,OAAO,EAIH,SAAS,GACZ,MAAM,YAAY,CAAC;AAQpB,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE;IAC9C,YAAY,EAAE,IAAI;IAClB,UAAU,EAAE,IAAI;IAChB,GAAG,EAAE;QACD,OAAO,IAAI,CAAC,MAAM,CAAM,SAAS,EAAE,EAAE,CAAC,CAAC;IAC3C,CAAC;CACJ,CAAC,CAAC"}

package/esm/sputilities/types.d.ts

@@ -0,0 +1,101 @@
+import { _SPQueryable, ISPQueryable, SPInit } from "../spqueryable.js";
+import { IPrincipalInfo, PrincipalType, PrincipalSource } from "../types.js";
+export declare class _Utilities extends _SPQueryable implements IUtilities {
+    constructor(base: string | ISPQueryable, methodName?: string);
+    excute<T>(props: any): Promise<T>;
+    sendEmail(properties: IEmailProperties): Promise<void>;
+    getCurrentUserEmailAddresses(): Promise<string>;
+    resolvePrincipal(input: string, scopes: PrincipalType, sources: PrincipalSource, inputIsEmailOnly: boolean, addToUserInfoList: boolean, matchUserInfoList?: boolean): Promise<IPrincipalInfo>;
+    searchPrincipals(input: string, scopes: PrincipalType, sources: PrincipalSource, groupName: string, maxCount: number): Promise<IPrincipalInfo[]>;
+    createEmailBodyForInvitation(pageAddress: string): Promise<string>;
+    expandGroupsToPrincipals(inputs: string[], maxCount?: number): Promise<IPrincipalInfo[]>;
+}
+/**
+ * Describes the SharePoint utility methods
+ */
+export interface IUtilities {
+    /**
+     * This methods will send an e-mail based on the incoming properties of the IEmailProperties parameter.
+     * @param props IEmailProperties object
+     */
+    sendEmail(props: IEmailProperties): Promise<void>;
+    /**
+     * This method returns the current user's email addresses known to SharePoint.
+     */
+    getCurrentUserEmailAddresses(): Promise<string>;
+    /**
+     * Gets information about a principal that matches the specified Search criteria.
+     * @param email E-mail address
+     * @param scopes Specifies the type to be used when searching for a principal
+     * @param sources Specifies the source to be used when searching for a principal.
+     * @param inputIsEmailOnly Specifies whether only the e-mail address will be used when searching for a principal.
+     * @param addToUserInfoList Specifies whether the user should be added to the hidden user info list.
+     * @param matchUserInfoList [Optional] By default false
+     */
+    resolvePrincipal(email: string, scopes: PrincipalType, sources: PrincipalSource, inputIsEmailOnly: boolean, addToUserInfoList: boolean, matchUserInfoList?: boolean): Promise<IPrincipalInfo>;
+    /**
+    * Gets information about the principals that match the specified search criteria.
+    * @param input Specifies the value to be used when searching for a principal.
+    * @param scopes Specifies the type to be used when searching for a principal.
+    * @param sources Specifies the source to be used when searching for a principal.
+    * @param groupName Specifies the collection of users to be used when searching for a principal.
+    * @param maxCount Specifies the maximum number of principals to be returned in the list.
+    */
+    searchPrincipals(input: string, scopes: PrincipalType, sources: PrincipalSource, groupName: string, maxCount: number): Promise<IPrincipalInfo[]>;
+    /**
+     * Gets the external (outside the firewall) URL to a document or resource in a site.
+     * @param pageAddress Specifies the URI for the document or resource. It must be a URL.
+     */
+    createEmailBodyForInvitation(pageAddress: string): Promise<string>;
+    /**
+     * Resolves the principals contained within the supplied groups.
+     * @param inputs A collection of groups to be expanded.
+     * @param maxCount Specifies the maximum number of principals to be returned.
+     */
+    expandGroupsToPrincipals(inputs: string[], maxCount?: number): Promise<IPrincipalInfo[]>;
+}
+export declare const Utilities: (base: SPInit, path?: string) => IUtilities;
+export interface IEmailProperties {
+    /**
+     * The list of receivers represented by a string array.
+     */
+    To: string[];
+    /**
+     * The list of receivers as CC (carbon copy) represented by a string array.
+     * This is optional.
+     */
+    CC?: string[];
+    /**
+     * The list of receivers as BCC (blind carbon copy) represented by a string array.
+     * This is optional.
+     */
+    BCC?: string[];
+    /**
+     * The subject of the email.
+     */
+    Subject: string;
+    /**
+     * The body of the email.
+     */
+    Body: string;
+    /**
+     * The additional headers appened to the request in key/value pairs.
+     */
+    AdditionalHeaders?: Record<string, string>;
+    /**
+     * The from address of the email.
+     * This is optional.
+     */
+    From?: string;
+}
+export interface IWikiPageCreationInfo {
+    /**
+     * The server-relative-url of the wiki page to be created.
+     */
+    ServerRelativeUrl: string;
+    /**
+     * The wiki content to be set in the wiki page.
+     */
+    WikiHtmlContent: string;
+}
+//# sourceMappingURL=types.d.ts.map