@zxncij2390/monorepo3 3.18.0

package/packages/sp/types.ts

@@ -0,0 +1,283 @@
+// reference: https://msdn.microsoft.com/en-us/library/office/dn600183.aspx
+
+export const emptyGuid = "00000000-0000-0000-0000-000000000000";
+
+/**
+ * Represents the unique sequential location of a change within the change log.
+ */
+export interface IChangeToken {
+    /**
+     * Gets or sets a string value that contains the serialized representation of the change token generated by the protocol server.
+     */
+    StringValue: string;
+}
+
+/**
+ * Contains options used to modify the behaviour of a move or copy operation
+ */
+export interface IMoveCopyOptions {
+    /**
+     * Boolean specifying whether to rename and copy the source file when the destination file exists
+     */
+    KeepBoth: boolean;
+
+    /**
+     * Boolean specifying whether to reset the destination of the copy author to the current user and the created by datetime to the current time.
+     */
+    ResetAuthorAndCreatedOnCopy: boolean;
+
+    /**
+     * Boolean specifying whether to allow File and Folder Move operations when file contain co-authoring shared locks
+     */
+    ShouldBypassSharedLocks: boolean;
+
+    /**
+     * Boolean specifying whether to retain the source of the move's editor and modified by datetime.
+     */
+    RetainEditorAndModifiedOnMove: boolean;
+}
+
+/**
+ * Defines a query that is performed against the change log.
+ */
+export interface IChangeQuery {
+    /**
+     * Gets or sets a value that specifies whether add changes are included in the query.
+     */
+    Add?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether changes to alerts are included in the query.
+     */
+    Alert?: boolean;
+
+    /**
+     * Gets or sets a value that specifies the end date and end time for changes that are returned through the query.
+     */
+    ChangeTokenEnd?: IChangeToken;
+
+    /**
+     * Gets or sets a value that specifies the start date and start time for changes that are returned through the query.
+     */
+    ChangeTokenStart?: IChangeToken;
+
+    /**
+     * Gets or sets a value that specifies whether changes to content types are included in the query.
+     */
+    ContentType?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether deleted objects are included in the query.
+     */
+    DeleteObject?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether changes to fields are included in the query.
+     */
+    Field?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether changes to files are included in the query.
+     */
+    File?: boolean;
+
+    /**
+     * Gets or sets value that specifies whether changes to folders are included in the query.
+     */
+    Folder?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether changes to groups are included in the query.
+     */
+    Group?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether adding users to groups is included in the query.
+     */
+    GroupMembershipAdd?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether deleting users from the groups is included in the query.
+     */
+    GroupMembershipDelete?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether general changes to list items are included in the query.
+     */
+    Item?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether changes to lists are included in the query.
+     */
+    List?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether move changes are included in the query.
+     */
+    Move?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether changes to the navigation structure of a site collection are included in the query.
+     */
+    Navigation?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether renaming changes are included in the query.
+     */
+    Rename?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether restoring items from the recycle bin or from backups is included in the query.
+     */
+    Restore?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether adding role assignments is included in the query.
+     */
+    RoleAssignmentAdd?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether adding role assignments is included in the query.
+     */
+    RoleAssignmentDelete?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether adding role assignments is included in the query.
+     */
+    RoleDefinitionAdd?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether adding role assignments is included in the query.
+     */
+    RoleDefinitionDelete?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether adding role assignments is included in the query.
+     */
+    RoleDefinitionUpdate?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether modifications to security policies are included in the query.
+     */
+    SecurityPolicy?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether changes to site collections are included in the query.
+     */
+    Site?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether updates made using the item SystemUpdate method are included in the query.
+     */
+    SystemUpdate?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether update changes are included in the query.
+     */
+    Update?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether changes to users are included in the query.
+     */
+    User?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether changes to views are included in the query.
+     */
+    View?: boolean;
+
+    /**
+     * Gets or sets a value that specifies whether changes to Web sites are included in the query.
+     */
+    Web?: boolean;
+}
+
+/**
+ * Specifies the type of a principal.
+ */
+export const enum PrincipalType {
+    /**
+     * Enumeration whose value specifies no principal type.
+     */
+    None = 0,
+    /**
+     * Enumeration whose value specifies a user as the principal type.
+     */
+    User = 1,
+    /**
+     * Enumeration whose value specifies a distribution list as the principal type.
+     */
+    DistributionList = 2,
+    /**
+     * Enumeration whose value specifies a security group as the principal type.
+     */
+    SecurityGroup = 4,
+    /**
+     * Enumeration whose value specifies a group as the principal type.
+     */
+    SharePointGroup = 8,
+    /**
+     * Enumeration whose value specifies all principal types.
+     */
+    // eslint-disable-next-line no-bitwise
+    All = SharePointGroup | SecurityGroup | DistributionList | User,
+}
+
+/**
+ * Specifies the source of a principal.
+ */
+export const enum PrincipalSource {
+    /**
+     * Enumeration whose value specifies no principal source.
+     */
+    None = 0,
+    /**
+     * Enumeration whose value specifies user information list as the principal source.
+     */
+    UserInfoList = 1,
+    /**
+     * Enumeration whose value specifies Active Directory as the principal source.
+     */
+    Windows = 2,
+    /**
+     * Enumeration whose value specifies the current membership provider as the principal source.
+     */
+    MembershipProvider = 4,
+    /**
+     * Enumeration whose value specifies the current role provider as the principal source.
+     */
+    RoleProvider = 8,
+    /**
+     * Enumeration whose value specifies all principal sources.
+     */
+    // eslint-disable-next-line no-bitwise
+    All = RoleProvider | MembershipProvider | Windows | UserInfoList,
+}
+
+export interface IPrincipalInfo {
+    Department: string;
+    DisplayName: string;
+    Email: string;
+    JobTitle: string;
+    LoginName: string;
+    Mobile: string;
+    PrincipalId: number;
+    PrincipalType: PrincipalType;
+    SIPAddress: string;
+}
+
+export enum PageType {
+    Invalid = -1,
+    DefaultView,
+    NormalView,
+    DialogView,
+    View,
+    DisplayForm,
+    DisplayFormDialog,
+    EditForm,
+    EditFormDialog,
+    NewForm,
+    NewFormDialog,
+    SolutionForm,
+    PAGE_MAXITEMS,
+}

package/packages/sp/user-custom-actions/index.ts

@@ -0,0 +1,15 @@
+import "./list.js";
+import "./web.js";
+import "./site.js";
+
+export {
+    IUserCustomAction,
+    IUserCustomActions,
+    IUserCustomActionAddResult,
+    IUserCustomActionUpdateResult,
+    UserCustomAction,
+    UserCustomActions,
+    IUserCustomActionInfo,
+    UserCustomActionRegistrationType,
+    UserCustomActionScope,
+} from "./types.js";

package/packages/sp/user-custom-actions/list.ts

@@ -0,0 +1,18 @@
+import { addProp } from "@pnp/queryable";
+import { _List } from "../lists/types.js";
+import { UserCustomActions, IUserCustomActions } from "./types.js";
+
+declare module "../lists/types" {
+    interface _List {
+        readonly userCustomActions: IUserCustomActions;
+    }
+
+    interface IList {
+        /**
+         * Get all custom actions on a list
+         */
+        readonly userCustomActions: IUserCustomActions;
+    }
+}
+
+addProp(_List, "userCustomActions", UserCustomActions);

package/packages/sp/user-custom-actions/site.ts

@@ -0,0 +1,18 @@
+import { addProp } from "@pnp/queryable";
+import { _Site } from "../sites/types.js";
+import { UserCustomActions, IUserCustomActions } from "./types.js";
+
+declare module "../sites/types" {
+    interface _Site {
+        readonly userCustomActions: IUserCustomActions;
+    }
+
+    interface ISite {
+        /**
+         * Get all custom actions on a site collection
+         */
+        readonly userCustomActions: IUserCustomActions;
+    }
+}
+
+addProp(_Site, "userCustomActions", UserCustomActions);

package/packages/sp/user-custom-actions/types.ts

@@ -0,0 +1,133 @@
+import {
+    _SPCollection,
+    spInvokableFactory,
+    deleteable,
+    _SPInstance,
+    IDeleteable,
+} from "../spqueryable.js";
+import { body } from "@pnp/queryable";
+import { defaultPath } from "../decorators.js";
+import { spPost, spPostMerge } from "../operations.js";
+import { IBasePermissions } from "../security/index.js";
+
+@defaultPath("usercustomactions")
+export class _UserCustomActions extends _SPCollection<IUserCustomActionInfo[]> {
+
+    /**
+     * Returns the user custom action with the specified id
+     *
+     * @param id The GUID id of the user custom action to retrieve
+     */
+    public getById(id: string): IUserCustomAction {
+        return UserCustomAction(this).concat(`('${id}')`);
+    }
+
+    /**
+     * Creates a user custom action
+     *
+     * @param properties The information object of property names and values which define the new user custom action
+     */
+    public async add(properties: Partial<IUserCustomActionInfo>): Promise<IUserCustomActionAddResult> {
+        const data = await spPost(this, body(properties));
+        return {
+            action: this.getById(data.Id),
+            data,
+        };
+    }
+
+    /**
+     * Deletes all user custom actions in the collection
+     */
+    public clear(): Promise<void> {
+        return spPost(UserCustomActions(this, "clear"));
+    }
+}
+export interface IUserCustomActions extends _UserCustomActions { }
+export const UserCustomActions = spInvokableFactory<IUserCustomActions>(_UserCustomActions);
+
+export class _UserCustomAction extends _SPInstance<IUserCustomActionInfo> {
+
+    public delete = deleteable();
+
+    /**
+    * Updates this user custom action with the supplied properties
+    *
+    * @param properties An information object of property names and values to update for this user custom action
+    */
+    public async update(props: Partial<IUserCustomActionInfo>): Promise<IUserCustomActionUpdateResult> {
+
+        const data = await spPostMerge(this, body(props));
+
+        return {
+            data,
+            action: this,
+        };
+    }
+}
+export interface IUserCustomAction extends _UserCustomAction, IDeleteable { }
+export const UserCustomAction = spInvokableFactory<IUserCustomAction>(_UserCustomAction);
+
+/**
+ * Result from adding a user custom action
+ */
+export interface IUserCustomActionAddResult {
+    /*
+     * The raw data returned from the add operation
+     */
+    data: any;
+
+    /*
+     * The added UserCustomAction
+     */
+    action: IUserCustomAction;
+}
+
+/**
+ * Result from udating a user custom action
+ */
+export interface IUserCustomActionUpdateResult {
+    /*
+     * The raw data returned from the update operation
+     */
+    data: any;
+
+    /*
+     * The updated UserCustomAction
+     */
+    action: IUserCustomAction;
+}
+
+export enum UserCustomActionRegistrationType {
+    None,
+    List,
+    ContentType,
+    ProgId,
+    FileType,
+}
+
+export enum UserCustomActionScope {
+    Unknown,
+    Site = 2,
+    Web,
+    List,
+}
+
+export interface IUserCustomActionInfo {
+    CommandUIExtension: string;
+    Description: string;
+    Group: string;
+    Id: string;
+    ImageUrl: string;
+    Location: string;
+    Name: string;
+    RegistrationId: string;
+    RegistrationType: UserCustomActionRegistrationType;
+    Rights: IBasePermissions;
+    Scope: UserCustomActionScope;
+    ScriptBlock: string;
+    ScriptSrc: string;
+    Sequence: number;
+    Title: string;
+    Url: string;
+    VersionOfUserCustomAction: string;
+}

package/packages/sp/user-custom-actions/web.ts

@@ -0,0 +1,21 @@
+import { addProp } from "@pnp/queryable";
+import { _Web } from "../webs/types.js";
+import { UserCustomActions, IUserCustomActions } from "./types.js";
+
+declare module "../webs/types" {
+    interface _Web {
+        /**
+         * Gets a newly refreshed collection of the SPWeb's SPUserCustomActionCollection
+         */
+        readonly userCustomActions: IUserCustomActions;
+    }
+
+    interface IWeb {
+        /**
+         * Gets a newly refreshed collection of the SPWeb's SPUserCustomActionCollection
+         */
+        readonly userCustomActions: IUserCustomActions;
+    }
+}
+
+addProp(_Web, "userCustomActions", UserCustomActions);

package/packages/sp/utils/encode-path-str.ts

@@ -0,0 +1,29 @@
+import { stringIsNullOrEmpty } from "@pnp/core";
+
+/**
+ * Encodes path portions of SharePoint urls such as decodedUrl=`encodePath(pathStr)`
+ *
+ * @param value The string path to encode
+ * @returns A path encoded for use in SP urls
+ */
+export function encodePath(value: string): string {
+
+    if (stringIsNullOrEmpty(value)) {
+        return "";
+    }
+
+    // replace all instance of ' with ''
+    if (/!(@.*?)::(.*?)/ig.test(value)) {
+
+        return value.replace(/!(@.*?)::(.*)$/ig, (match, labelName, v) => {
+            // we do not need to encodeURIComponent v as it will be encoded automatically when it is added as a query string param
+            // we do need to double any ' chars
+            return `!${labelName}::${v.replace(/'/ig, "''")}`;
+        });
+
+    } else {
+
+        // because this is a literal path value we encodeURIComponent after doubling any ' chars
+        return encodeURIComponent(value.replace(/'/ig, "''"));
+    }
+}

package/packages/sp/utils/extract-web-url.ts

@@ -0,0 +1,21 @@
+import { stringIsNullOrEmpty } from "@pnp/core";
+
+export function extractWebUrl(candidateUrl: string): string {
+
+    if (stringIsNullOrEmpty(candidateUrl)) {
+        return "";
+    }
+
+    let index = candidateUrl.indexOf("_api/");
+
+    if (index < 0) {
+        index = candidateUrl.indexOf("_vti_bin/");
+    }
+
+    if (index > -1) {
+        return candidateUrl.substring(0, index);
+    }
+
+    // if all else fails just give them what they gave us back
+    return candidateUrl;
+}

package/packages/sp/utils/file-names.ts

@@ -0,0 +1,35 @@
+// eslint-disable-next-line no-control-regex
+const InvalidFileFolderNameCharsOnlineRegex = /["*:<>?/\\|\x00-\x1f\x7f-\x9f]/g;
+// eslint-disable-next-line no-control-regex
+const InvalidFileFolderNameCharsOnPremiseRegex = /["#%*:<>?/\\|\x00-\x1f\x7f-\x9f]/g;
+
+/**
+ * Checks if file or folder name contains invalid characters
+ *
+ * @param input File or folder name to check
+ * @param onPremise Set to true for SharePoint On-Premise
+ * @returns True if contains invalid chars, false otherwise
+ */
+export function containsInvalidFileFolderChars(input: string, onPremise = false): boolean {
+    if (onPremise) {
+        return InvalidFileFolderNameCharsOnPremiseRegex.test(input);
+    } else {
+        return InvalidFileFolderNameCharsOnlineRegex.test(input);
+    }
+}
+
+/**
+ * Removes invalid characters from file or folder name
+ *
+ * @param input File or folder name
+ * @param replacer Value that will replace invalid characters
+ * @param onPremise Set to true for SharePoint On-Premise
+ * @returns File or folder name with replaced invalid characters
+ */
+export function stripInvalidFileFolderChars(input: string, replacer = "", onPremise = false): string {
+    if (onPremise) {
+        return input.replace(InvalidFileFolderNameCharsOnPremiseRegex, replacer);
+    } else {
+        return input.replace(InvalidFileFolderNameCharsOnlineRegex, replacer);
+    }
+}

package/packages/sp/utils/metadata.ts

@@ -0,0 +1,5 @@
+export function metadata(type: string) {
+    return {
+        "__metadata": { "type": type },
+    };
+}

package/packages/sp/utils/odata-url-from.ts

@@ -0,0 +1,42 @@
+import { combine, hOP, isUrlAbsolute } from "@pnp/core";
+import { extractWebUrl } from "./extract-web-url.js";
+
+export function odataUrlFrom(candidate: any): string {
+
+    const parts: string[] = [];
+    const s = ["odata.type", "odata.editLink", "__metadata", "odata.metadata", "odata.id"];
+
+    if (hOP(candidate, s[0]) && candidate[s[0]] === "SP.Web") {
+
+        // webs return an absolute url in the id
+        if (hOP(candidate, s[4])) {
+            parts.push(candidate[s[4]]);
+        } else if (hOP(candidate, s[2])) {
+            // we are dealing with verbose, which has an absolute uri
+            parts.push(candidate.__metadata.uri);
+        }
+
+    } else {
+
+        if (hOP(candidate, s[3]) && hOP(candidate, s[1])) {
+            // we are dealign with minimal metadata (default)
+
+            // some entities return an abosolute url in the editlink while for others it is relative
+            // without the _api. This code is meant to handle both situations
+            const editLink = isUrlAbsolute(candidate[s[1]]) ? candidate[s[1]].split("_api")[1] : candidate[s[1]];
+
+            parts.push(extractWebUrl(candidate[s[3]]), "_api", editLink);
+        } else if (hOP(candidate, s[1])) {
+            parts.push("_api", candidate[s[1]]);
+        } else if (hOP(candidate, s[2])) {
+            // we are dealing with verbose, which has an absolute uri
+            parts.push(candidate.__metadata.uri);
+        }
+    }
+
+    if (parts.length < 1) {
+        return "";
+    }
+
+    return combine(...parts);
+}

package/packages/sp/utils/to-resource-path.ts

@@ -0,0 +1,9 @@
+export interface IResourcePath {
+    DecodedUrl: string;
+}
+
+export function toResourcePath(url: string): IResourcePath {
+    return {
+        DecodedUrl: url,
+    };
+}

package/packages/sp/views/index.ts

@@ -0,0 +1,14 @@
+import "./list.js";
+
+export {
+    IView,
+    IViewFields,
+    IViews,
+    View,
+    ViewFields,
+    Views,
+    IViewAddResult,
+    IViewUpdateResult,
+    IViewInfo,
+    ViewScope,
+} from "./types.js";

package/packages/sp/views/list.ts

@@ -0,0 +1,33 @@
+import { addProp } from "@pnp/queryable";
+import { _List } from "../lists/types.js";
+import { Views, IViews, IView, View } from "./types.js";
+
+declare module "../lists/types" {
+    interface _List {
+        readonly views: IViews;
+        readonly defaultView: IView;
+        getView(id: string): IView;
+    }
+    interface IList {
+        /**
+         * Gets the views on this list
+         */
+        readonly views: IViews;
+        /**
+         * Gets the default view for this list
+         */
+        readonly defaultView: IView;
+        /**
+         * Gets a view by view guid id
+         *
+         */
+        getView(id: string): IView;
+    }
+}
+
+addProp(_List, "views", Views);
+addProp(_List, "defaultView", View);
+
+_List.prototype.getView = function (this: _List, viewId: string): IView {
+    return View(this, `getView('${viewId}')`);
+};