@kwiz/common 1.0.4 → 1.0.6

package/src/utils/sharepoint.rest/list.ts

@@ -1,9 +1,12 @@
 import { BaseTypes, FieldTypeAsString, FieldTypes, GeListItemsFoldersBehaviour, IDictionary, IFieldInfo, IFieldInfoEX, IFieldInfoExHash, IFieldJsonSchema, IFieldLookupInfo, IListWorkflowAssociation, IRestItem, IRestOptions, ISPEventReceiver, ListExperienceOptions, ListTemplateTypes, NormalizeListName, PageType, PushNoDuplicate, SPBasePermissionKind, SPBasePermissions, SafeIfElse, SchemaXmlToJson, contentTypes, extendFieldInfo, firstOrNull, iContentType, iList, iListView, isBoolean, isNotEmptyArray, isNullOrEmptyArray, isNullOrEmptyString, isNullOrUndefined, isNumber, isPromise, isString, isValidGuid, jsonStringify, jsonTypes, makeServerRelativeUrl, makeUniqueArray, normalizeGuid, normalizeUrl, toHash } from "../_dependencies";
+import { ConsoleLogger } from "../consolelogger";
 import { GetJson, GetJsonSync, longLocalCache, shortLocalCache } from "../rest";
 import { GetRestBaseUrl, GetSiteUrl, LIST_EXPAND, LIST_SELECT } from "./common";
 import { __fixGetListItemsResults } from "./listutils/common";
 import { GetContentTypes, GetContentTypesSync, GetListsSync } from "./web";
 
+const logger = ConsoleLogger.get("SharePoint.Rest.List");
+
 /** returns /_api/web/lists/getById() or /_api/web/lists/getByTitle() */
 export function GetListRestUrl(siteUrl: string, listIdOrTitle: string): string {
     siteUrl = GetSiteUrl(siteUrl);
@@ -1141,4 +1144,145 @@ export async function CreateList(siteUrl: string, info: {
     let newList = (await GetJson<{ d: iCreateListResult }>(url, jsonStringify(body))).d;
     normalizeGuid(newList.Id);
     return newList;
+}
+
+export async function SearchList(siteUrl: string, listIdOrTitle: string, query: string) {
+    let listId = GetListId(siteUrl, listIdOrTitle);
+    let url = `${GetRestBaseUrl(siteUrl)}/search/query?querytext='(${query}*)'&querytemplate='{searchTerms} (NormListID:${listId})'`;
+
+    try {
+        const result = await GetJson<{
+            ElapsedTime: number,
+            PrimaryQueryResult: {
+                CustomResults: [];
+                QueryId: string;//"7fdf01b1-f6f0-4d42-b046-d9db22597084",
+                QueryRuleId: string;// "00000000-0000-0000-0000-000000000000",
+                RefinementResults: null,
+                RelevantResults: {
+                    RowCount: number,
+                    Table: {
+                        Rows: {
+                            Cells: {
+                                Key:
+                                /** "1989637621861439888" "Edm.Int64" */
+                                "WorkId"
+                                /** "1000.1073372","Edm.Double" */
+                                | "Rank"
+                                /** "sample md as text","Edm.String" */
+                                | "Title"
+                                /** "Shai Petel", "Edm.String" */
+                                | "Author"
+                                /** "91", "Edm.Int64" */
+                                | "Size"
+                                /** "https://kwizcom.sharepoint.com/sites/s/cms/CMSPages/sample md as text.txt", "Edm.String" */
+                                | "Path"
+                                /** null, "Null" */
+                                | "Description"
+                                /** "# hello world! - bullet - bullet | table | col | | ----- | ---- | |table |col | ", "Edm.String" */
+                                | "HitHighlightedSummary"
+                                /** "https://kwizcom.sharepoint.com/_api/v2.1/drives/b!8NAeO-mocUWbgyMTqcM0Mfh8XKPhn7xOhhMrO5KfJjBs_gXb9j8ZRaLxuppgj0Uk/items/01OBXW4FLU6G4LIT7AX5BK3MXHDICVTIOT/thumbnails/0/c400x99999/content?prefer=noRedirect", "Edm.String" */
+                                | "PictureThumbnailURL"
+                                /** null,"Null" */
+                                | "ServerRedirectedURL"
+                                /** null,"Null" */
+                                | "ServerRedirectedEmbedURL"
+                                /** null,"Null" */
+                                | "ServerRedirectedPreviewURL"
+                                /** "txt","Edm.String" */
+                                | "FileExtension"
+                                /** "0x010100CB212272F1372446A2423F0A2BEA12B8", "Edm.String" */
+                                | "ContentTypeId"
+                                /** "https://kwizcom.sharepoint.com/sites/s/cms/CMSPages/Forms/AllItems.aspx","Edm.String" */
+                                | "ParentLink"
+                                /** "1","Edm.Int64" */
+                                | "ViewsLifeTime"
+                                /** "1","Edm.Int64" */
+                                | "ViewsRecent"
+                                /** "2024-02-22T18:35:48.0000000Z","Edm.DateTime" */
+                                | "LastModifiedTime"
+                                /** "txt","Edm.String" */
+                                | "FileType"
+                                /** "1989637621861439888","Edm.Int64" */
+                                | "DocId"
+                                /** "https://kwizcom.sharepoint.com/sites/s/cms","Edm.String" */
+                                | "SPWebUrl"
+                                /** "{b4b8f174-e04f-42bf-adb2-e71a0559a1d3}","Edm.String" */
+                                | "UniqueId"
+                                /** "3b1ed0f0-a8e9-4571-9b83-2313a9c33431","Edm.String" */
+                                | "SiteId"
+                                /** "a35c7cf8-9fe1-4ebc-8613-2b3b929f2630","Edm.String" */
+                                | "WebId"
+                                /** "db05fe6c-3ff6-4519-a2f1-ba9a608f4524","Edm.String" */
+                                | "ListId"
+                                /** "https://kwizcom.sharepoint.com/sites/s/cms/CMSPages/sample md as text.txt","Edm.String" */
+                                | "OriginalPath"
+                                ;
+                                Value: string,
+                                ValueType: "Edm.Int64" | "Edm.Double" | "Edm.String" | "Edm.DateTime" | "Null"
+                            }[]
+                        }[]
+                    },
+                    TotalRows: number,
+                    TotalRowsIncludingDuplicates: number
+                }
+            },
+        }>(url, null, { jsonMetadata: jsonTypes.nometadata });
+        logger.json(result.PrimaryQueryResult.RelevantResults, `search ${query}`);
+        let rows = result.PrimaryQueryResult.RelevantResults.Table.Rows;
+
+        const mapped: (IDictionary<string | Date | number> & {
+            WorkId?: number;
+            Rank?: number;
+            Title?: string;
+            Author?: string;
+            Size?: number;
+            Path?: string;
+            Description?: string;
+            HitHighlightedSummary?: string;
+            PictureThumbnailURL?: string;
+            ServerRedirectedURL?: string;
+            ServerRedirectedEmbedURL?: string;
+            ServerRedirectedPreviewURL?: string;
+            FileExtension?: string;
+            ContentTypeId?: string;
+            ParentLink?: string;
+            ViewsLifeTime?: number;
+            ViewsRecent?: number;
+            LastModifiedTime?: Date;
+            FileType?: string;
+            DocId?: number;
+            SPWebUrl?: string;
+            UniqueId?: string;
+            SiteId?: string;
+            WebId?: string;
+            ListId?: string;
+            OriginalPath?: string;
+            $itemId?: number;
+        })[] = [];
+        rows.forEach(r => {
+            try {
+                const rowValues: IDictionary<string | Date | number> = {};
+                r.Cells.forEach(cell => {
+                    rowValues[cell.Key] = cell.ValueType === "Edm.Int64" || cell.ValueType === "Edm.Double"
+                        ? parseInt(cell.Value, 10)
+                        : cell.ValueType === "Edm.DateTime"
+                            ? new Date(cell.Value)
+                            : cell.ValueType === "Null"
+                                ? ""
+                                : cell.Value
+                });
+                let resultPath = isNullOrEmptyString(rowValues.Path) ? "" : (rowValues.Path as string).toLowerCase();
+                let indexOfId = resultPath.toLowerCase().indexOf("id=");
+                let itemId = indexOfId >= 0 ? parseInt(resultPath.slice(indexOfId + 3)) : -1;
+                if (itemId >= 0)
+                    rowValues.$itemId = itemId;
+                mapped.push(rowValues);
+            } catch (e) { return null; }
+        });
+
+        return mapped;
+    } catch (e) {
+        logger.error(e);
+        return [];
+    }
 }

package/src/utils/sharepoint.rest/user-search.ts

@@ -2,14 +2,10 @@ import { IUserInfo, PrincipalType, contentTypes, firstIndexOf, jsonTypes } from
 import { GetJson } from "../rest";
 import { EnsureUser } from "./user";
 
-interface IPeoplePickerUserItem {
-    /**
-     * LoginName or Id of the principal in the site.
-     */
+export interface iPeoplePickerUserItem {
+    /** LoginName or Id of the principal in the site. */
     id: string;
-    /**
-     * LoginName of the principal.
-     */
+    /** LoginName of the principal. */
     loginName: string;
     imageUrl: string;
     imageInitials: string;
@@ -72,7 +68,7 @@ export class SPPeopleSearchService {
     /**
      * Search person by its email or login name
      */
-    public async searchPersonByEmailOrLogin(email: string, principalTypes: PrincipalType[], siteUrl: string = null, groupId: number = null, ensureUser: boolean = false): Promise<IPeoplePickerUserItem> {
+    public async searchPersonByEmailOrLogin(email: string, principalTypes: PrincipalType[], siteUrl: string = null, groupId: number = null, ensureUser: boolean = false): Promise<iPeoplePickerUserItem> {
         // if (Environment.type === EnvironmentType.Local) {
         //     // If the running environment is local, load the data from the mock
         //     const mockUsers = await this.searchPeopleFromMock(email);
@@ -86,7 +82,7 @@ export class SPPeopleSearchService {
     /**
      * Search All Users from the SharePoint People database
      */
-    public async searchPeople(query: string, maximumSuggestions: number, principalTypes: PrincipalType[], siteUrl: string = null, groupId: number = null, ensureUser: boolean = false): Promise<IPeoplePickerUserItem[]> {
+    public async searchPeople(query: string, maximumSuggestions: number, principalTypes: PrincipalType[], siteUrl: string = null, groupId: number = null, ensureUser: boolean = false): Promise<iPeoplePickerUserItem[]> {
         // if (Environment.type === EnvironmentType.Local) {
         //     // If the running environment is local, load the data from the mock
         //     return this.searchPeopleFromMock(query);
@@ -98,7 +94,7 @@ export class SPPeopleSearchService {
     /**
      * Tenant search
      */
-    private async searchTenant(siteUrl: string, query: string, maximumSuggestions: number, principalTypes: PrincipalType[], ensureUser: boolean, groupId: number): Promise<IPeoplePickerUserItem[]> {
+    private async searchTenant(siteUrl: string, query: string, maximumSuggestions: number, principalTypes: PrincipalType[], ensureUser: boolean, groupId: number): Promise<iPeoplePickerUserItem[]> {
         try {
             // If the running env is SharePoint, loads from the peoplepicker web service
             const userRequestUrl: string = `${siteUrl || this.context.siteUrl}/_api/SP.UI.ApplicationPages.ClientPeoplePickerWebServiceInterface.clientPeoplePickerSearchUser`;
@@ -171,7 +167,7 @@ export class SPPeopleSearchService {
                                 secondaryText: element.EntityData.Email || element.Description, // email
                                 tertiaryText: "", // status
                                 optionalText: "" // anything
-                            } as IPeoplePickerUserItem;
+                            } as iPeoplePickerUserItem;
                         case 'SecGroup':
                             return {
                                 id: element.Key,
@@ -179,7 +175,7 @@ export class SPPeopleSearchService {
                                 imageInitials: this.getFullNameInitials(element.DisplayText),
                                 text: element.DisplayText,
                                 secondaryText: element.ProviderName
-                            } as IPeoplePickerUserItem;
+                            } as iPeoplePickerUserItem;
                         case 'FormsRole':
                             return {
                                 id: element.Key,
@@ -187,7 +183,7 @@ export class SPPeopleSearchService {
                                 imageInitials: this.getFullNameInitials(element.DisplayText),
                                 text: element.DisplayText,
                                 secondaryText: element.ProviderName
-                            } as IPeoplePickerUserItem;
+                            } as iPeoplePickerUserItem;
                         default:
                             return {
                                 id: element.EntityData.SPGroupID,
@@ -195,7 +191,7 @@ export class SPPeopleSearchService {
                                 imageInitials: this.getFullNameInitials(element.DisplayText),
                                 text: element.DisplayText,
                                 secondaryText: element.EntityData.AccountName
-                            } as IPeoplePickerUserItem;
+                            } as iPeoplePickerUserItem;
                     }
                 });
 

package/src/utils/sharepoint.rest/user.ts

@@ -1,9 +1,10 @@
-import { IGroupInfo, ISPPeoplePickerControlFormEntity, IUserInfo, IsSPPeoplePickerControlFormEntity, PrincipalType, encodeURIComponentEX, getPrincipalTypeFromPickerEntity, isNullOrEmptyString, isNullOrNaN, isNullOrUndefined, isNumber, jsonStringify, jsonTypes } from "../_dependencies";
-//import { ConsoleLogger } from "../consolelogger";
+import { IGroupInfo, ISPPeoplePickerControlFormEntity, IUserInfo, IsSPPeoplePickerControlFormEntity, PrincipalType, contentTypes, encodeURIComponentEX, getPrincipalTypeFromPickerEntity, isNullOrEmptyArray, isNullOrEmptyString, isNullOrNaN, isNullOrUndefined, isNumber, jsonStringify, jsonTypes } from "../_dependencies";
+import { ConsoleLogger } from "../consolelogger";
 import { GetJson, GetJsonSync, longLocalCache, shortLocalCache } from "../rest";
 import { GetRestBaseUrl, GetSiteUrl } from "./common";
+import { GetSiteId } from "./web";
 
-//const logger = ConsoleLogger.get("utils/sharepoint/user");
+const logger = ConsoleLogger.get("utils/sharepoint/user");
 var __currentUserId: number = null;
 const groupSelect = "Id,Title,Description,CanCurrentUserViewMembership,OnlyAllowMembersViewMembership,IsHiddenInUI,OwnerTitle";
 const userSelect = "PrincipalType,Id,LoginName,UserPrincipalName,Title,IsSiteAdmin,Email";
@@ -444,4 +445,49 @@ export async function AddUserToGroup(siteUrl: string, groupId: number, userIdOrL
 export async function RemoveUserFromGroup(siteUrl: string, groupId: number, userId: number): Promise<void> {
     let url = `${GetRestBaseUrl(siteUrl)}/web/siteGroups(${groupId})/users/removeById(${userId})`;
     await GetJson(url, null, { method: "POST", allowCache: false, jsonMetadata: jsonTypes.nometadata });
+}
+
+export async function SetGroupOwner(siteUrl: string, groupId: number, ownerId: number, ownerIsAGroup?: boolean) {
+    //https://github.com/SharePoint/sp-dev-docs/issues/5031#issuecomment-594710013
+    //if owner is a group - rest API doens't work.
+    if (ownerIsAGroup !== true) {
+        let url = `${GetRestBaseUrl(siteUrl)}/web/siteGroups/getById('${groupId}')/SetUserAsOwner(${ownerId})`;
+        try {
+            await GetJson<{ 'odata.null': true }>(url, null, { jsonMetadata: jsonTypes.nometadata, method: "POST" });
+            return true;
+        } catch (e) {
+            logger.error(`SetGroupOwner ${groupId} ${ownerId} error:`);
+            logger.error(e);
+            return false;
+        }
+    }
+    else {
+        try {
+            let soapUrl = `${GetSiteUrl(siteUrl)}_vti_bin/client.svc/ProcessQuery`;
+            let siteId = await GetSiteId(siteUrl);
+            let serviceJSONResponse = await GetJson<{ ErrorInfo?: string }[]>(soapUrl, `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="15.0.0.0" ApplicationName=".NET Library" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009">
+<Actions>
+  <SetProperty Id="1" ObjectPathId="2" Name="Owner">
+    <Parameter ObjectPathId="3" />
+  </SetProperty>
+  <Method Name="Update" Id="4" ObjectPathId="2" />
+</Actions>
+<ObjectPaths>
+  <Identity Id="2" Name="740c6a0b-85e2-48a0-a494-e0f1759d4aa7:site:${siteId}:g:${groupId}" />
+  <Identity Id="3" Name="740c6a0b-85e2-48a0-a494-e0f1759d4aa7:site:${siteId}:g:${ownerId}" />
+</ObjectPaths>
+</Request>`, {
+                headers: {
+                    Accept: jsonTypes.standard,
+                    "content-type": contentTypes.xml
+                }
+            });
+            //logger.json(serviceJSONResponse, "soap result");
+            return isNullOrEmptyArray(serviceJSONResponse) || isNullOrEmptyString(serviceJSONResponse[0].ErrorInfo);
+        } catch (e) {
+            logger.error(`SetGroupOwner via SOAP ${ownerId} ${ownerId} error:`);
+            logger.error(e);
+            return false;
+        }
+    }
 }

package/src/utils/sharepoint.rest/web.ts

@@ -1,4 +1,4 @@
-import { IAppTile, IContextWebInformation, IDictionary, IFieldInfoEX, IRestOptions, IRestRoleDefinition, IRootWebInfo, ISiteInfo, ITimeZone, IUserCustomActionInfo, IWebBasicInfo, IWebInfo, IWebRegionalSettings, SPBasePermissionKind, SPBasePermissions, WebTypes, extendFieldInfo, getGlobal, iContentType, iList, isDate, isNotEmptyArray, isNullOrEmptyArray, isNullOrEmptyString, isNullOrUndefined, isString, isTypeofFullNameNullOrUndefined, isValidGuid, jsonTypes, makeServerRelativeUrl, normalizeGuid, normalizeUrl, sortArray } from "../_dependencies";
+import { IAppTile, IContextWebInformation, IDictionary, IFieldInfoEX, IGroupInfo, IRestOptions, IRestRoleDefinition, IRootWebInfo, ISiteInfo, ITimeZone, IUserCustomActionInfo, IUserInfo, IWebBasicInfo, IWebInfo, IWebRegionalSettings, SPBasePermissionKind, SPBasePermissions, WebTypes, extendFieldInfo, getGlobal, iContentType, iList, isDate, isNotEmptyArray, isNullOrEmptyArray, isNullOrEmptyString, isNullOrUndefined, isString, isTypeofFullNameNullOrUndefined, isValidGuid, jsonStringify, jsonTypes, makeServerRelativeUrl, normalizeGuid, normalizeUrl, sortArray } from "../_dependencies";
 import { ConsoleLogger } from "../consolelogger";
 import { toIsoDateFormat } from "../date";
 import { GetJson, GetJsonSync, longLocalCache, mediumLocalCache, shortLocalCache, weeekLongLocalCache } from "../rest";
@@ -636,6 +636,18 @@ export async function GetWebRoleDefinitions(siteUrl: string): Promise<IRestRoleD
         .catch<IRestRoleDefinition[]>(() => []);
 }
 
+export interface iRoleAssignment {
+    Member: IGroupInfo | IUserInfo,
+    RoleDefinitionBindings: IRestRoleDefinition[],
+    PrincipalId: 14
+};
+/** get roles for site or list */
+export async function GetRoleAssignments(siteUrl: string, listIdOrTitle?: string) {
+    const url = `${isNullOrEmptyString(listIdOrTitle) ? GetRestBaseUrl(siteUrl) + "/web" : GetListRestUrl(siteUrl, listIdOrTitle)}/roleassignments?$expand=Member/users,RoleDefinitionBindings`;
+    const result = await GetJson<{ value: iRoleAssignment[] }>(url, undefined, { jsonMetadata: jsonTypes.nometadata });
+    return result.value;
+}
+
 /** Web sub webs for the selected site */
 export async function GetSubWebs(siteUrl: string, options?: { allowAppWebs?: boolean; }): Promise<IWebInfo[]> {
     return GetJson<{ d: { results: IWebInfo[]; }; }>(GetRestBaseUrl(siteUrl) + `/web/webs${options && options.allowAppWebs ? "" : "&$filter=WebTemplate ne 'APP'"}`, null,
@@ -1029,3 +1041,13 @@ export async function RemoveWebPermission(siteUrl: string, principalId: number,
     let url = `${GetRestBaseUrl(siteUrl)}/web/roleassignments/removeroleassignment(principalid=${principalId},roleDefId=${roleId})`;
     await GetJson(url, undefined, { method: "POST", allowCache: false, jsonMetadata: jsonTypes.nometadata });
 }
+
+/** set a user as site admin - rejects/throws if not successful */
+export async function SetUserAsSiteAdmin(siteUrl: string, userId: number) {
+    const url = `${GetRestBaseUrl(siteUrl)}/web/getuserbyid(${userId})`;
+    await GetJson<{}>(url, jsonStringify({
+        "__metadata": { "type": "SP.User" },
+        "IsSiteAdmin": true
+    }), { method: 'POST', xHttpMethod: 'MERGE' });
+    return true;
+}