spws/src/services/userGroup/getCurrentUserID.ts

SharePoint Web Services Wrapper

// SPWS Library
import { defaults } from "../..";

// Classes
import { SpwsError } from "../../classes";

// Enum

// Services
// import {  } from "../..";

// Types
import { SpwsResponse } from "../../types";

// Utils

interface CurrentUserID extends SpwsResponse {
  data: string;
}

/**
 * Gets the current user's ID
 * @param options The SharePoint web URL
 * @param options.webURL The SharePoint web URL
 * @param options.getFromWindow If false, the user ID will be scraped from the SharePoint page.
 * @example
 * ```
 * // Get the current user ID
 * const res = await getCurrentUserID();
 *
 * // Get the current user ID
 * const res = await getCurrentUserID({ getFromWindow: false });
 * ```
 */
const getCurrentUserID = ({
  webURL = defaults.webURL,
  getFromWindow = true,
} = {}): Promise<CurrentUserID> =>
  new Promise((resolve, reject) => {
    let globalUserID =
      getFromWindow &&
      ((window._spPageContextInfo && window._spPageContextInfo.userId) || window._spUserId);
    // If the user ID exists in window
    if (globalUserID)
      return resolve({
        data: globalUserID.toString(),
        responseText: "",
        responseXML: document.implementation.createHTMLDocument(""),
        status: 200,
        statusText: "success",
      });

    // Create xhr
    let xhr = new XMLHttpRequest();
    xhr.open("GET", `${webURL}/_layouts/viewlsts.aspx`, false);

    xhr.onreadystatechange = () => {
      if (xhr.readyState === 4) {
        if (xhr.status === 200) {
          // Get SharePoint User ID variable
          const spUserId = xhr.responseText.match(/userId:[0-9]+/gim);

          // If not found, reject with error
          if (!spUserId)
            return reject(
              new SpwsError({
                message: "Page does not contain the _spUserId, unable to getCurrentUser",
              })
            );

          // Return the ID from the matched string
          return resolve({
            data: spUserId[0].split(":")[1],
            responseText: xhr.responseText,
            responseXML: xhr.responseXML!,
            status: xhr.status,
            statusText: xhr.statusText,
          });
        } else if (xhr.status === 404) {
          // Create response error
          reject(
            new SpwsError({
              status: xhr.status,
              statusText: xhr.statusText,
              message: "Site not found",
            })
          );
        } else {
          // Create response error
          reject(new SpwsError({ message: "Unable to get SharePoint User ID" }));
        }
      }
    };
    xhr.send();
  });

export default getCurrentUserID;