@lindle/sharepoint_requests 0.1.9 → 0.1.11

package/dist/root/index.d.ts

@@ -8,13 +8,29 @@ declare class HTTPSharePointRequests<T extends {
     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).
+     */
     constructor(baseURL: string);
+    /**
+     * 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;
     /**
      * @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[];
             meta: {
@@ -22,25 +38,49 @@ declare class HTTPSharePointRequests<T extends {
             };
         }>;
     };
+    /**
+     * 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>>;
+        create: (data: ListData) => Promise<AxiosResponse<any, any, {}>>;
         get: (options?: Options<T['LISTS'][K]>) => Promise<{
             data: (T["LISTS"][K] & Partial<SPItem>)[];
             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>>;
+        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]>) => {
             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: {
@@ -48,7 +88,18 @@ 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: {
@@ -63,12 +114,56 @@ declare class HTTPSharePointRequests<T extends {
      * @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: {
         /**
@@ -99,27 +194,88 @@ declare class HTTPSharePointRequests<T extends {
             d: {
                 SendEmail: null;
             };
-        }, any>>;
+        }, 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/instance.d.ts

@@ -0,0 +1,3 @@
+import { CreateAxiosDefaults } from 'axios';
+export declare const instance: (baseURL: string, config?: CreateAxiosDefaults) => import("axios").AxiosInstance;
+export default instance;