@lindle/sharepoint_requests 0.1.18 → 0.1.20

package/src/types.ts

@@ -1,118 +1,119 @@
-export type Metadata = {
-  id?: string;
-  type?: string;
-  uri?: string;
-  etag?: string;
-};
-
-export type SPItem2010 = {
-  Attachments: string;
-  ContentType: string;
-  ContentTypeID: string;
-  Created: string;
-  CreatedBy: PersonField & _Deferred;
-  CreatedById: string;
-  Modified: string;
-  ModifiedBy: PersonField & _Deferred;
-  ModifiedById: string;
-  Id: number;
-  Title: string;
-  Path: string;
-  Version: string;
-  Owshiddenversion: number;
-  __metadata: Metadata;
-};
-
-export type SPItem2013 = {
-  __metadata: Metadata;
-  FirstUniqueAncestorSecurableObject: _Deferred;
-  RoleAssignments: _Deferred;
-  AttachmentFiles: _Deferred;
-  ContentType: _Deferred;
-  GetDlpPolicyTip: _Deferred;
-  FieldValuesAsHtml: _Deferred;
-  FieldValuesAsText: _Deferred;
-  FieldValuesForEdit: _Deferred;
-  File: _Deferred;
-  Folder: _Deferred;
-  ParentList: _Deferred;
-  FileSystemObjectType: number;
-  Id: number;
-  ContentTypeId: string;
-  Title: string;
-  PhotoRefId?: number;
-  ID: number;
-  Modified: string;
-  Created: string;
-  AuthorId: number;
-  EditorId: number;
-  OData__UIVersionString?: string;
-  Attachments: boolean;
-  GUID: string;
-  Author?: PersonField & _Deferred;
-  Editor?: PersonField & _Deferred;
-  [key: string]: unknown;
-};
-
-export type SPItem<V extends SHAREPOINT_VER = '2013'> = V extends '2010'
-  ? SPItem2010
-  : SPItem2013;
-
-type ListFields<K, V extends SHAREPOINT_VER = '2013'> =
-  | Extract<keyof K, string>
-  | Extract<keyof SPItem<V>, string>;
-
-export interface Options<K = any, V extends SHAREPOINT_VER = '2013'> {
-  expand?: ListFields<K, V>[] | ListFields<K, V>;
-  orderBy?: ListFields<K, V> | [ListFields<K, V>, 'asc' | 'desc'];
-  limit?: number;
-  filter?: string;
-  cols?: ListFields<K, V>[] | ListFields<K, V>;
+export type Metadata = {
+  id?: string;
+  type?: string;
+  uri?: string;
+  etag?: string;
+};
+
+export type SPItem2010 = {
+  Attachments: string;
+  ContentType: string;
+  ContentTypeID: string;
+  Created: string;
+  CreatedBy: PersonField & _Deferred;
+  CreatedById: string;
+  Modified: string;
+  ModifiedBy: PersonField & _Deferred;
+  ModifiedById: string;
+  Id: number;
+  Title: string;
+  Path: string;
+  Version: string;
+  Owshiddenversion: number;
+  __metadata: Metadata;
+};
+
+export type SPItem2013 = {
+  __metadata: Metadata;
+  FirstUniqueAncestorSecurableObject: _Deferred;
+  RoleAssignments: _Deferred;
+  AttachmentFiles: _Deferred;
+  ContentType: _Deferred;
+  GetDlpPolicyTip: _Deferred;
+  FieldValuesAsHtml: _Deferred;
+  FieldValuesAsText: _Deferred;
+  FieldValuesForEdit: _Deferred;
+  File: _Deferred;
+  Folder: _Deferred;
+  ParentList: _Deferred;
+  FileSystemObjectType: number;
+  Id: number;
+  ContentTypeId: string;
+  Title: string;
+  PhotoRefId?: number;
+  ID: number;
+  Modified: string;
+  Created: string;
+  AuthorId: number;
+  EditorId: number;
+  OData__UIVersionString?: string;
+  Attachments: boolean;
+  GUID: string;
+  Author?: PersonField & _Deferred;
+  Editor?: PersonField & _Deferred;
+  [key: string]: unknown;
+};
+
+export type SPItem<V extends SHAREPOINT_VER = '2013'> = V extends '2010'
+  ? SPItem2010
+  : SPItem2013;
+
+type ListFields<K, V extends SHAREPOINT_VER = '2013'> =
+  | Extract<keyof K, string>
+  | Extract<keyof SPItem<V>, string>;
+
+type OrderByDirection = 'asc' | 'desc';
+type OrderByExpression<F extends string> = F | (F | OrderByDirection)[];
+
+export interface Options<K = any, V extends SHAREPOINT_VER = '2013'> {
+  expand?: ListFields<K, V>[] | ListFields<K, V>;
+  orderBy?: OrderByExpression<ListFields<K, V>>;
+  limit?: number;
+  filter?: string;
+  cols?: ListFields<K, V>[] | ListFields<K, V>;
   skip?: number;
 }
 export interface Folder_Options<K = any> {
-  type: 'Files' | 'Folders';
+  type?: 'Files' | 'Folders';
   expand?: Extract<keyof K, string>[] | Extract<keyof K, string>;
-  orderBy?:
-    | Extract<keyof K, string>
-    | [Extract<keyof K, string>, 'asc' | 'desc'];
+  orderBy?: OrderByExpression<Extract<keyof K, string>>;
   limit?: number;
   filter?: string;
   cols?: Extract<keyof K, string>[] | Extract<keyof K, string>;
   skip?: number;
 }
 
-export interface Field_Options<
-  K,
-  V extends SHAREPOINT_VER = '2013'
-> extends Omit<Options<K, V>, 'filter'> {
-  fieldName?: Extract<keyof K, string>;
-}
+export interface Field_Options<K, V extends SHAREPOINT_VER = '2013'>
+  extends Omit<Options<K, V>, 'filter'> {
+  fieldName?: Extract<keyof K, string>;
+}
 
 export type SHAREPOINT_VER = '2010' | '2013';
 
-export type IListName<T> = Extract<keyof T, string>;
+export type IListName<T> = T extends { LISTS: Record<string, unknown> }
+  ? Extract<keyof T['LISTS'], string>
+  : Extract<keyof T, string>;
 
-export type ItemID = string | number;
-export type CreateFileProps = {
-  file: File;
-  itemId: ItemID;
-};
-export type UploadFileProps = {
-  file: File;
-  folderPath?: string | string[];
-  overwrite?: boolean;
-};
-export type DeleteFileProps = {
-  fileName: string;
-  folderPath?: string | string[];
-};
+export type ItemID = string | number;
+export type CreateFileProps = {
+  file: File;
+  itemId: ItemID;
+};
+export type UploadFileProps = {
+  file: File;
+  folderPath?: string | string[];
+  overwrite?: boolean;
+};
+export type DeleteFileProps = {
+  fileName: string;
+  folderPath?: string | string[];
+};
 
-export type EmailProps = {
-  From: string;
-  To: string[] | string;
-  Subject?: string;
-  Body: string;
+export type EmailProps = {
+  From: string;
+  To: string[] | string;
+  Subject?: string;
+  Body: string;
 };
 
 export type _Deferred = {
@@ -121,54 +122,55 @@ export type _Deferred = {
   };
 };
 
-declare const LOOKUP_FIELD_TAG: unique symbol;
-type LookupFieldMarker = {
-  [LOOKUP_FIELD_TAG]?: true;
-};
-
-export type LookupField<T> = _Deferred & T & LookupFieldMarker;
-export type ChoiceField<T> = _Deferred & {
-  Value: T;
-  __metadata: Metadata;
-};
-
-type MetadataEnvelope = {
-  __metadata?: {
-    type: string;
-  };
-};
-
-type EnsureRecord<T> = T extends Record<string, unknown>
-  ? T
-  : Record<string, unknown>;
-
-type LookupCreateValue =
-  | number
-  | string
-  | null
-  | {
-      lookupId: number | string;
-    }
-  | {
-      LookupId: number | string;
-    }
-  | {
-      results: (number | string)[];
-    };
-
-type NormalizeField<T> = T extends LookupField<unknown>
-  ? LookupCreateValue | LookupField<unknown>
-  : T;
-
-export type ListData<T = Record<string, unknown>> = Partial<{
-  [K in keyof EnsureRecord<T>]: NormalizeField<EnsureRecord<T>[K]>;
-}> &
-  MetadataEnvelope;
-
-export type PersonField = {
-  AboutMe?: string;
-  Account: string;
-  AccountName: string;
+type LookupFieldMarker = {
+  __lookupFieldBrand?: true;
+};
+
+export type LookupField<T> = _Deferred & T & LookupFieldMarker;
+export type ChoiceField<T> = _Deferred & {
+  Value: T;
+  __metadata: Metadata;
+};
+
+type MetadataEnvelope = {
+  __metadata?: {
+    type: string;
+  };
+};
+
+type EnsureRecord<T> = T extends Record<string, unknown>
+  ? T
+  : Record<string, unknown>;
+
+type LookupCreateValue =
+  | number
+  | string
+  | null
+  | {
+      lookupId: number | string;
+    }
+  | {
+      LookupId: number | string;
+    }
+  | {
+      results: (number | string)[];
+    };
+
+type NormalizeField<T> = T extends LookupField<unknown>
+  ? LookupCreateValue | LookupField<unknown>
+  : T;
+
+export type ListData<T = Record<string, unknown>> = Partial<
+  {
+    [K in keyof EnsureRecord<T>]: NormalizeField<EnsureRecord<T>[K]>;
+  }
+> &
+  MetadataEnvelope;
+
+export type PersonField = {
+  AboutMe?: string;
+  Account: string;
+  AccountName: string;
   AdministrativeSupervisor: string;
   AskMeAbout?: string;
   AskMeAbout0?: string;
@@ -236,7 +238,7 @@ export type MultiPersonField = {
 
 export type PermissionLabel = 'Full Control' | 'Edit' | 'Contribute' | 'Read';
 
-export type UserPermision = {
+export type UserPermission = {
   BasePermissions: {
     High: string;
     Low: string;
@@ -253,6 +255,9 @@ export type UserPermision = {
   __metadata: Metadata;
 };
 
+/** @deprecated Use `UserPermission` instead. */
+export type UserPermision = UserPermission;
+
 export type CurrentUser = {
   Email: string;
   Id: number;

package/dist/root/index.d.ts

@@ -1,88 +0,0 @@
-import { CreateAxiosDefaults as AxiosConfig } from 'axios';
-import { CreateFileProps, DeleteFileProps, CurrentUser, EmailProps, Field_Options, Folder_Options, UploadFileProps, IListName, ItemID, ListData, Options, PersonField, SHAREPOINT_VER, UserPermision, UserProfile } from '../types';
-declare class HTTPSharePointRequests<T extends {
-    LISTS: Record<string, unknown>;
-    FOLDERS?: Record<string, unknown>;
-}> {
-    private baseURL;
-    private endpoint;
-    private listName;
-    private instance;
-    private sharepointVersion;
-    private listItemEntityTypeFullName?;
-    constructor(baseURL: string, config?: AxiosConfig);
-    private getContext;
-    private resolveListItemEntityTypeFullName;
-    /**
-     * @deprecated Use `from` instead.
-     */
-    list(listName: IListName<T>): this;
-    readonly lists: {
-        get: () => Promise<{
-            data: Partial<import("../types").SPItem2013>[];
-            meta: {
-                url: URL;
-            };
-        }>;
-    };
-    getDigest(): Promise<string>;
-    from<K extends Extract<keyof T['LISTS'], string>, V extends SHAREPOINT_VER = '2013'>(listName: K, sharepoint_ver?: V): {
-        create: (data: ListData<T["LISTS"][K]>) => 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<T["LISTS"][K]>, 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, {}>>;
-        uploadFile: (props: UploadFileProps) => Promise<import("axios").AxiosResponse<any, any, {}> & {
-            itemId?: ItemID;
-        }>;
-        deleteFile: (props: DeleteFileProps) => Promise<import("axios").AxiosResponse<any, any, {}>>;
-        fields: (options?: Field_Options<T["LISTS"][K], V>) => {
-            get: () => Promise<any>;
-        };
-    };
-    folders: {
-        get: () => void;
-    };
-    folder(folderName?: string | string[]): {
-        get: (options?: Folder_Options<any>) => Promise<{
-            data: any;
-            meta: {
-                url: URL;
-            };
-        }>;
-    };
-    users(options?: Options<any>): {
-        get: () => Promise<{
-            data: any[];
-            meta: {
-                url: URL;
-            };
-        }>;
-    };
-    email: {
-        send: (props: EmailProps) => Promise<import("axios").AxiosResponse<{
-            d: {
-                SendEmail: null;
-            };
-        }, any, {}>>;
-    };
-    user: {
-        properties: () => {
-            get: () => Promise<UserProfile>;
-        };
-        searchSiteUser: (searchValue: string) => Promise<any>;
-        searchUser: (input: string, filter?: string) => Promise<PersonField>;
-        current: () => {
-            get: () => Promise<CurrentUser>;
-        };
-        currentPermission: () => {
-            get: () => Promise<UserPermision>;
-        };
-    };
-}
-export default HTTPSharePointRequests;

package/dist/root/instance.d.ts

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

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

@@ -1,11 +0,0 @@
-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;
-    listItemEntityTypeFullName?: string;
-    resolveListItemEntityType?: () => Promise<string>;
-}

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

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

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

@@ -1,10 +0,0 @@
-import type { AxiosResponse } from 'axios';
-import type { EmailProps } from '../../types';
-import type { RequestContext } from './context';
-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

@@ -1,3 +0,0 @@
-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

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

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

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

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

@@ -1,3 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,3 +0,0 @@
-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

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

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

@@ -1,4 +0,0 @@
-import type { ListData } from '../../../types';
-type AnyRecord = Record<string, unknown>;
-export declare function normalizeListPayload<D = Record<string, unknown>>(data: ListData<D>): AnyRecord;
-export {};

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

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

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

@@ -1,6 +0,0 @@
-import type { AxiosResponse } from 'axios';
-import type { ItemID, SHAREPOINT_VER, UploadFileProps } from '../../../types';
-import type { RequestContext } from '../context';
-export declare function uploadFile<V extends SHAREPOINT_VER = '2013'>(context: RequestContext<V>, { file, folderPath, overwrite }: UploadFileProps): Promise<AxiosResponse & {
-    itemId?: ItemID;
-}>;

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

@@ -1,2 +0,0 @@
-export declare function buildLibraryPath(folderPath?: string | string[]): string;
-export declare function encodeFileName(fileName: string): string;

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

@@ -1,5 +0,0 @@
-import type { Folder_Options, Options, SHAREPOINT_VER } from '../../types';
-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

@@ -1,15 +0,0 @@
-import type { AxiosInstance } from 'axios';
-import type { PersonField, UserPermision, UserProfile } from '../../types';
-import type { RequestContext } from './context';
-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 {};