@lindle/sharepoint_requests 0.1.12 → 0.1.14

package/dist/root/index.d.ts

@@ -1,87 +1,47 @@
-import { AxiosResponse, CreateAxiosDefaults as AxiosConfig } from 'axios';
-import { CreateFileProps, CurrentUser, EmailProps, Field_Options, Folder_Options, IListName, ItemID, ListData, Options, PersonField, SHAREPOINT_VER, SPItem, UserPermision, UserProfile } from '../types';
+import { CreateAxiosDefaults as AxiosConfig } from 'axios';
+import { CreateFileProps, CurrentUser, EmailProps, Field_Options, Folder_Options, IListName, ItemID, ListData, Options, PersonField, SHAREPOINT_VER, UserPermision, UserProfile } from '../types';
 declare class HTTPSharePointRequests<T extends {
-    LISTS: Record<string, any>;
-    FOLDERS?: Record<string, any>;
+    LISTS: Record<string, unknown>;
+    FOLDERS?: Record<string, unknown>;
 }> {
     private baseURL;
     private endpoint;
     private listName;
     private instance;
-    /**
-     * Creates an HTTP SharePoint requester bound to the provided base URL.
-     *
-     * @param baseURL The root SharePoint site URL (with or without trailing slash).
-     * @param config Optional axios configuration overrides.
-     */
+    private sharepointVersion;
     constructor(baseURL: string, config?: AxiosConfig);
-    /**
-     * Converts array values in a payload to the `Collection(Edm.String)` structure
-     * expected by SharePoint REST endpoints.
-     *
-     * @param data The list item payload to harmonise in-place.
-     */
-    private transformArraysToEdmStrings;
+    private getContext;
     /**
      * @deprecated Use `from` instead.
      */
     list(listName: IListName<T>): this;
     readonly lists: {
-        /**
-         * Fetches all SharePoint lists available to the current site.
-         *
-         * @returns Promise resolving to the list collection response payload.
-         */
         get: () => Promise<{
-            data: any[];
+            data: Partial<import("../types").SPItem2013>[];
             meta: {
                 url: URL;
             };
         }>;
     };
-    /**
-     * Selects a SharePoint list and exposes list-scoped CRUD helpers.
-     *
-     * @param listName Logical list key configured in the generic type map.
-     * @param sharepoint_ver SharePoint version used to choose the correct REST endpoint.
-     * @returns Chainable helpers bound to the selected list.
-     */
-    from<K extends Extract<keyof T['LISTS'], string>>(listName: K, sharepoint_ver?: SHAREPOINT_VER): {
-        create: (data: ListData) => Promise<AxiosResponse<any, any, {}>>;
-        get: (options?: Options<T['LISTS'][K]>) => Promise<{
-            data: (T["LISTS"][K] & Partial<SPItem>)[];
+    from<K extends Extract<keyof T['LISTS'], string>, V extends SHAREPOINT_VER = '2013'>(listName: K, sharepoint_ver?: V): {
+        create: (data: ListData) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+        get: (options?: Options<T['LISTS'][K], V>) => Promise<{
+            data: (T["LISTS"][K] & Partial<import("../types").SPItem<V>>)[];
             meta: {
                 url: URL;
             };
         }>;
-        update: (id: ItemID, data: ListData, digest?: string) => Promise<AxiosResponse<any, any, {}>>;
-        delete: (id: ItemID) => Promise<AxiosResponse<any, any, {}>>;
-        createFile: (props: CreateFileProps) => Promise<AxiosResponse<any, any, {}>>;
-        fields: (options?: Field_Options<T['LISTS'][K]>) => {
+        update: (id: ItemID, data: ListData, digest?: string) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+        delete: (id: ItemID) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+        createFile: (props: CreateFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
+        fields: (options?: Field_Options<T['LISTS'][K], V>) => {
             get: () => Promise<any>;
         };
     };
     folders: {
-        /**
-         * Retrieves SharePoint folders from the default folders endpoint.
-         *
-         * @returns A promise resolving with folder metadata.
-         */
         get: () => void;
     };
-    /**
-     * Targets a SharePoint folder path and exposes file retrieval helpers.
-     *
-     * @param folderName Optional folder path relative to `Shared Documents`.
-     * @returns Helper exposing `get` to fetch files or sub-folders.
-     */
     folder(folderName?: string | string[]): {
-        /**
-         * Fetches files or folders from the targeted path.
-         *
-         * @param options Optional REST query options to refine the result set.
-         * @returns Promise resolving to folder contents and metadata.
-         */
         get: (options?: Folder_Options<any>) => Promise<{
             data: any;
             meta: {
@@ -89,18 +49,7 @@ declare class HTTPSharePointRequests<T extends {
             };
         }>;
     };
-    /**
-     * Retrieves user list items and exposes a get helper with optional query parameters.
-     *
-     * @param options Optional REST query options.
-     * @returns Helper exposing `get` returning SharePoint user rows.
-     */
     users(options?: Options<any>): {
-        /**
-         * Executes the user list request using the specified options.
-         *
-         * @returns Promise resolving to the SharePoint user list response.
-         */
         get: () => Promise<{
             data: any[];
             meta: {
@@ -108,175 +57,25 @@ declare class HTTPSharePointRequests<T extends {
             };
         }>;
     };
-    /**
-     * Asynchronously retrieves the Form Digest Value from the context information API.
-     *
-     * @returns {Promise<string>} A promise that resolves to the Form Digest Value.
-     * @throws {Error} If the HTTP request fails or the response does not contain the expected data.
-     */
-    private getDigest;
-    /**
-     * Executes a GET request without additional metadata wrapping.
-     *
-     * @param options Optional REST query options.
-     * @returns SharePoint response payload or undefined when empty.
-     */
-    private get_only;
-    /**
-     * Retrieves folder contents with optional filtering and returns the payload with metadata.
-     *
-     * @param options REST options describing expand/filter/order conditions.
-     * @returns Folder data and the fully resolved request URL.
-     */
-    private get_files;
-    /**
-     * Performs a typed list read against the current endpoint.
-     *
-     * @param options Optional REST query options governing expand, filter, ordering and pagination.
-     * @returns SharePoint list items alongside the fully-resolved request URL.
-     */
-    private get_v2;
-    /**
-     * Updates an item in the currently selected list.
-     *
-     * @param id Target list item identifier.
-     * @param data Payload with fields to update.
-     * @param digest Optional pre-fetched form digest to reuse.
-     * @returns Axios response of the update request.
-     */
-    private update_2;
-    /**
-     * Creates a new item within the active list.
-     *
-     * @param listData SharePoint list item payload.
-     * @returns Axios response resolved from the create request.
-     */
-    private create_v2;
-    /**
-     * Uploads an attachment file to an existing list item.
-     *
-     * @param props File payload and target item identifier.
-     * @returns Axios response describing the upload result.
-     */
-    private createFile;
-    /**
-     * Deletes an item using the current endpoint.
-     *
-     * @param ID Identifier of the entity to remove.
-     * @returns Axios response from the delete call.
-     */
-    private delete;
     email: {
-        /**
-         * Sends an email using SharePoint's Utility.SendEmail API.
-         *
-         * @param {EmailProps} param0 - The email properties.
-         * @param {string} param0.From - The sender's email address.
-         * @example
-         *  Example of a sender's email address
-         *  "sender@example.com"
-         * @param {string | string[]} param0.To - The recipient's email address or an array of email addresses.
-         * @example
-         *  Example of a single recipient's email address
-         *   "recipient@example.com"
-         *  Example of multiple recipients' email addresses
-         *  ["recipient1@example.com", "recipient2@example.com"]
-         * @param {string} param0.Subject - The subject of the email.
-         * @example
-         *  Example of an email subject
-         *  "Meeting Reminder"
-         * @param {string} param0.Body - The body content of the email.
-         * @example
-         *  Example of an email body
-         *  "Dear team, please be reminded of the meeting scheduled for tomorrow at 10 AM."
-         * @returns {Promise<any>} - A promise that resolves to the response of the email send request.
-         */
-        send: (props: EmailProps) => Promise<AxiosResponse<{
+        send: (props: EmailProps) => Promise<import("axios").AxiosResponse<{
             d: {
                 SendEmail: null;
             };
         }, any, {}>>;
     };
-    private sendEmail;
-    /**
-     * Queries SharePoint's people picker endpoint for matching users.
-     *
-     * @param input Free-text search term.
-     * @param filter Optional additional filter condition.
-     * @returns Promise with type-ahead results payload.
-     */
-    private typeAhead;
-    /**
-     * Retrieves the current user profile and flattens selected properties.
-     *
-     * @returns Promise containing the current user's profile information.
-     */
-    private currentUserProperties;
     user: {
-        /**
-         * Provides accessors for the current user's profile information.
-         *
-         * @returns Helper exposing a `get` function to retrieve profile details.
-         */
         properties: () => {
             get: () => Promise<UserProfile>;
         };
-        /**
-         * Searches across site users and their groups.
-         *
-         * @param searchValue Query string to match site users.
-         * @returns Promise resolving to matching site users.
-         */
         searchSiteUser: (searchValue: string) => Promise<any>;
-        /**
-         * Performs a people-picker search scoped to the current site collection.
-         *
-         * @param input Search prefix.
-         * @param filter Optional additional filter condition.
-         * @returns Promise with type-ahead person results.
-         */
         searchUser: (input: string, filter?: string) => Promise<PersonField>;
-        /**
-         * Fetches the currently authenticated SharePoint user.
-         *
-         * @returns Helper exposing `get` that resolves to the current user payload.
-         */
         current: () => {
             get: () => Promise<CurrentUser>;
         };
-        /**
-         * Retrieves calculated permission level for the current user.
-         *
-         * @returns Helper exposing `get` resolving to the user's permission definition.
-         */
         currentPermission: () => {
             get: () => Promise<UserPermision>;
         };
     };
-    /**
-     * Searches site users based on a substring match across common fields.
-     *
-     * @param searchValue Term to match against the SharePoint user directory.
-     * @returns Promise with matching site users and their groups.
-     */
-    private getSiteUser;
-    /**
-     * Retrieves all available role definitions for the current site.
-     *
-     * @returns Promise resolving to an array of role definitions.
-     */
-    private roleDefinitions;
-    /**
-     * Fetches the bit-encoded permissions of the current user.
-     *
-     * @returns Promise resolving to the `EffectiveBasePermissions` object.
-     */
-    private getEffectiveBasePermissions;
-    /**
-     * Matches the current user's effective permissions against known role definitions.
-     *
-     * @returns The matching SharePoint role definition as a structured permission object.
-     */
-    private currentUserPermissions;
 }
 export default HTTPSharePointRequests;

package/dist/root/internal/context.d.ts

@@ -0,0 +1,9 @@
+import type { AxiosInstance } from 'axios';
+import type { SHAREPOINT_VER } from '../../types';
+export interface RequestContext<V extends SHAREPOINT_VER = '2013'> {
+    instance: AxiosInstance;
+    baseURL: string;
+    endpoint: string;
+    listName: string;
+    sharepointVersion: V;
+}

package/dist/root/internal/digest.d.ts

@@ -0,0 +1,2 @@
+import type { AxiosInstance } from 'axios';
+export declare function fetchDigest(instance: AxiosInstance, baseURL: string): Promise<string>;

package/dist/root/internal/emailRequests.d.ts

@@ -0,0 +1,10 @@
+import type { AxiosResponse } from 'axios';
+import type { EmailProps } from '../../types';
+import type { RequestContext } from './context';
+declare type SendEmailResponse = AxiosResponse<{
+    d: {
+        SendEmail: null;
+    };
+}>;
+export declare function sendEmail(context: RequestContext, { From, To, Subject, Body }: EmailProps): Promise<SendEmailResponse>;
+export {};

package/dist/root/internal/listRequests/createAttachment.d.ts

@@ -0,0 +1,3 @@
+import type { CreateFileProps, SHAREPOINT_VER } from '../../../types';
+import type { RequestContext } from '../context';
+export declare function createAttachment<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, { file, itemId }: CreateFileProps): Promise<import("axios").AxiosResponse<any, any, {}>>;

package/dist/root/internal/listRequests/createListItem.d.ts

@@ -0,0 +1,3 @@
+import type { ListData, SHAREPOINT_VER } from '../../../types';
+import type { RequestContext } from '../context';
+export declare function createListItem<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, listData: ListData): Promise<import("axios").AxiosResponse<any, any, {}>>;

package/dist/root/internal/listRequests/deleteItem.d.ts

@@ -0,0 +1,3 @@
+import type { SHAREPOINT_VER } from '../../../types';
+import type { RequestContext } from '../context';
+export declare function deleteItem<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, id: number | string): Promise<import("axios").AxiosResponse<any, any, {}>>;

package/dist/root/internal/listRequests/getFiles.d.ts

@@ -0,0 +1,8 @@
+import type { Folder_Options, SHAREPOINT_VER } from '../../../types';
+import type { RequestContext } from '../context';
+export declare function getFiles<T, V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, options?: Folder_Options<T>): Promise<{
+    data: any;
+    meta: {
+        url: URL;
+    };
+}>;

package/dist/root/internal/listRequests/getListItems.d.ts

@@ -0,0 +1,8 @@
+import type { Options, SPItem, SHAREPOINT_VER } from '../../../types';
+import type { RequestContext } from '../context';
+export declare function getListItems<K, V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, options?: Options<K, V>): Promise<{
+    data: (K & Partial<SPItem<V>>)[];
+    meta: {
+        url: URL;
+    };
+}>;

package/dist/root/internal/listRequests/getOnly.d.ts

@@ -0,0 +1,3 @@
+import type { AxiosInstance } from 'axios';
+import type { Options, SHAREPOINT_VER } from '../../../types';
+export declare function getOnly<T, V extends SHAREPOINT_VER = '2013'>(instance: AxiosInstance, endpoint: string, options?: Options<T, V>): Promise<any>;

package/dist/root/internal/listRequests/index.d.ts

@@ -0,0 +1,7 @@
+export { createListItem } from './createListItem';
+export { createAttachment } from './createAttachment';
+export { deleteItem } from './deleteItem';
+export { getFiles } from './getFiles';
+export { getListItems } from './getListItems';
+export { getOnly } from './getOnly';
+export { updateListItem } from './updateListItem';

package/dist/root/internal/listRequests/updateListItem.d.ts

@@ -0,0 +1,3 @@
+import type { ListData, SHAREPOINT_VER } from '../../../types';
+import type { RequestContext } from '../context';
+export declare function updateListItem<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, id: number | string, data: ListData, digest?: string): Promise<import("axios").AxiosResponse<any, any, {}>>;

package/dist/root/internal/odata.d.ts

@@ -0,0 +1,5 @@
+import type { Folder_Options, Options, SHAREPOINT_VER } from '../../types';
+declare type QueryableOptions<T, V extends SHAREPOINT_VER = '2013'> = Options<T, V> | Folder_Options<T>;
+export declare function buildODataParams<T, V extends SHAREPOINT_VER = '2013'>(options: QueryableOptions<T, V> | undefined, orderBySeparator?: ',' | ' '): Record<string, string | number>;
+export declare function appendParamsToUrl(baseUrl: URL, params: Record<string, string | number | undefined | null>): void;
+export {};

package/dist/root/internal/userRequests.d.ts

@@ -0,0 +1,15 @@
+import type { AxiosInstance } from 'axios';
+import type { PersonField, UserPermision, UserProfile } from '../../types';
+import type { RequestContext } from './context';
+declare type RoleDefinition = {
+    BasePermissions: {
+        High: string;
+    };
+};
+export declare function typeAhead(instance: AxiosInstance, input: string, filter?: string): Promise<PersonField>;
+export declare function currentUserProperties(instance: AxiosInstance): Promise<UserProfile>;
+export declare function getSiteUser(instance: AxiosInstance, searchValue: string): Promise<any>;
+export declare function roleDefinitions(instance: AxiosInstance): Promise<RoleDefinition[]>;
+export declare function getEffectiveBasePermissions(instance: AxiosInstance): Promise<any>;
+export declare function currentUserPermissions(context: RequestContext): Promise<UserPermision>;
+export {};