spws/src/services/lists/getFirstItemID.ts

SharePoint Web Services Wrapper

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

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

// Enum
// import {  } from "../../enum";

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

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

// Utils
// import {  } from "../../utils";

interface Operation extends SpwsBatchResponse {
  data: number;
}

const getFirstItemID = async (
  listName: string,
  { webURL = defaults.webURL }: { webURL?: string } = {}
): Promise<Operation> => {
  try {
    const res = await getListItems(listName, {
      query: `<Where><IsNotNull><FieldRef Name="ID" /></IsNotNull></Where><OrderBy><FieldRef Name="ID" Ascending="TRUE" /></OrderBy>`,
      fields: ["ID"],
      rowLimit: 1,
      webURL,
      batch: false,
    });

    // Validate response
    if (res.data.length > 1)
      throw new SpwsError({
        message: "Unable to get first item ID. More than 1 item was returned",
      });

    if (res.data.length === 0) return { ...res, data: 0 };
    // throw new SpwsError({
    //   message: "Unable to get first item ID. No items were returned",
    // });

    // Get the item ID
    const data = +res.data[0].ID!;

    // Return object
    return { ...res, data };
  } catch (error: any) {
    throw new SpwsError(error);
  }
};

export default getFirstItemID;