@lindle/sharepoint_requests 0.1.17 → 0.1.19

package/src/types.ts

@@ -1,121 +1,113 @@
-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 ListData =
-  | {
-      [key: string]: any;
-      __metadata?: {
-        type: string;
-      };
-    }
-  | any;
+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;
@@ -130,12 +122,51 @@ export type _Deferred = {
   };
 };
 
-export type LookupField<T> = _Deferred & T;
+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;
@@ -224,6 +255,8 @@ export type UserPermision = {
   __metadata: Metadata;
 };
 
+export type UserPermission = UserPermision;
+
 export type CurrentUser = {
   Email: string;
   Id: number;