@lindle/sharepoint_requests 0.1.9-beta.0

package/src/types/index.ts

@@ -0,0 +1,342 @@
+export type Metadata = {
+  id?: string;
+  type?: string;
+  uri?: string;
+  etag?: string;
+};
+
+export type SPItem = {
+  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;
+};
+
+type ListFields<K> = Extract<keyof K, string> | keyof SPItem;
+
+export interface Options<K = any> {
+  expand?: ListFields<K>[] | ListFields<K>;
+  orderBy?: ListFields<K> | [ListFields<K>, 'asc' | 'desc'];
+  limit?: number;
+  filter?: string;
+  cols?: ListFields<K>[] | ListFields<K>;
+  skip?: number;
+}
+export interface Folder_Options<K = any> {
+  type: 'Files' | 'Folders';
+  expand?: Extract<keyof K, string>[] | Extract<keyof K, string>;
+  orderBy?:
+    | Extract<keyof K, string>
+    | [Extract<keyof K, string>, 'asc' | 'desc'];
+  limit?: number;
+  filter?: string;
+  cols?: Extract<keyof K, string>[] | Extract<keyof K, string>;
+  skip?: number;
+}
+
+export interface Field_Options<K> extends Omit<Options<K>, 'filter'> {
+  fieldName?: Extract<keyof K, string>;
+}
+
+export type SHAREPOINT_VER = '2010' | '2013';
+
+export type IListName<T> = Extract<keyof T, string>;
+
+export type ItemID = string | number;
+export type CreateFileProps = {
+  file: File;
+  itemId: ItemID;
+};
+
+export type ListData =
+  | {
+      [key: string]: any;
+      __metadata?: {
+        type: string;
+      };
+    }
+  | any;
+
+export type EmailProps = {
+  From: string;
+  To: string[] | string;
+  Subject?: string;
+  Body: string;
+};
+
+export type _Deferred = {
+  __deferred: {
+    uri: string;
+  };
+};
+
+export type LookupField<T> = _Deferred & T;
+export type ChoiceField<T> = _Deferred & {
+  Value: T;
+  __metadata: Metadata;
+};
+
+export type PersonField = {
+  AboutMe?: string;
+  Account: string;
+  AccountName: string;
+  AdministrativeSupervisor: string;
+  AskMeAbout?: string;
+  AskMeAbout0?: string;
+  Assistant?: string;
+  Attachments: unknown;
+  BuildingName: string;
+  BusinessLine: string;
+  CellPhone?: string;
+  City?: string;
+  Company: string;
+  CompanyCode: string;
+  ContentType: string;
+  ContentTypeID: string;
+  CostCenter: string;
+  Country: string;
+  Created: string; // Datum ve formátu "/Date(1723530019000)/"
+  CreatedBy: PersonField;
+  CreatedById: number;
+  Deleted: boolean;
+  Department: string;
+  Department0?: string;
+  Division: string;
+  Fax?: string;
+  FirstName: string;
+  Hidden: boolean;
+  Id?: string;
+  Id0: number;
+  Interests?: string;
+  IsSiteAdmin: boolean;
+  JobTitle?: string;
+  LANID: string;
+  LastName: string;
+  Manager: string;
+  MobilePhone: string;
+  Modified: string; // Datum ve formátu "/Date(1731958716000)/"
+  ModifiedBy: PersonField;
+  ModifiedById: number;
+  Name: string;
+  Office: string;
+  OfficeLocation?: string;
+  Owshiddenversion: number;
+  Pager?: string;
+  Path: string;
+  Picture: string;
+  PictureExchangeSyncState: number;
+  PicturePlaceholderState: number;
+  PictureTimestamp: string;
+  SIPAddress?: string;
+  Schools?: string;
+  Skills?: string;
+  State: string;
+  Title: string;
+  UserName: string;
+  Version: string;
+  WebSite?: string;
+  WorkEmail: string;
+  WorkHistory?: string;
+  WorkPhone?: string;
+  __metadata: Metadata;
+};
+
+export type MultiPersonField = {
+  results: PersonField[];
+};
+
+export type PermissionLabel = 'Full Control' | 'Edit' | 'Contribute' | 'Read';
+
+export type UserPermision = {
+  BasePermissions: {
+    High: string;
+    Low: string;
+    __metadata: {
+      type: 'SP.BasePermissions';
+    };
+  };
+  Description: string;
+  Hidden: boolean;
+  Id: number;
+  Name: PermissionLabel;
+  Order: number;
+  RoleTypeKind: number;
+  __metadata: Metadata;
+};
+
+export type CurrentUser = {
+  Email: string;
+  Id: number;
+  IsHiddenInUI: boolean;
+  LoginName: string;
+  PrincipalType: number;
+  Title: string;
+  __metadata: Metadata;
+};
+
+export type UserProfilePropKey =
+  | 'UserProfile_GUID'
+  | 'SID'
+  | 'FirstName'
+  | 'ADGuid'
+  | 'SPS-PhoneticFirstName'
+  | 'LastName'
+  | 'XOM-LANID'
+  | 'UserName'
+  | 'SPS-PhoneticLastName'
+  | 'AccountName'
+  | 'PictureURL'
+  | 'MiddleName'
+  | 'PreferredName'
+  | 'PhoenticName'
+  | 'SPS-PhoneticDisplayName'
+  | 'SPS-JobTitle'
+  | 'Title'
+  | 'BuildingName'
+  | 'Office'
+  | 'WorkPhone'
+  | 'SPS-SipAddress'
+  | 'CellPhone'
+  | 'HomePhone'
+  | 'Pager'
+  | 'Fax'
+  | 'WorkEmail'
+  | 'SPS-Location'
+  | 'State'
+  | 'Country'
+  | 'Assistant'
+  | 'SPS-RegionalSettings-FollowWeb'
+  | 'SPS-Locale'
+  | 'SPS-CalendarType'
+  | 'SPS-AltCalendarType'
+  | 'SPS-AdjustHijriDays'
+  | 'SPS-ShowWeeks'
+  | 'SPS-WorkDays'
+  | 'SPS-WorkDayStartHour'
+  | 'SPS-WorkDayEndHour'
+  | 'SPS-Time24'
+  | 'SPS-FirstDayOfWeek'
+  | 'SPS-FirstWeekOfYear'
+  | 'SPS-RegionalSettings-Initialized'
+  | 'SPS-TimeZone'
+  | 'Company'
+  | 'Division'
+  | 'BusinessLine'
+  | 'SPS-Department'
+  | 'Department'
+  | 'XOM-CompanyCode'
+  | 'Manager'
+  | 'SPS-Dotted-line'
+  | 'XOM-CostCenter'
+  | 'SPS-HireDate'
+  | 'AboutMe'
+  | 'SPS-Responsibility'
+  | 'SPS-PastProjects'
+  | 'WorkHistory'
+  | 'SPS-Skills'
+  | 'SPS-Interests'
+  | 'SPS-School'
+  | 'SPS-Birthday'
+  | 'WebSite'
+  | 'PersonalSpace'
+  | 'PublicSiteRedirect'
+  | 'QuickLinks'
+  | 'SPS-DataSource'
+  | 'SPS-Memberof'
+  | 'SPS-Peers'
+  | 'SPS-MySiteUpgrade'
+  | 'SPS-DontSuggestList'
+  | 'SPS-ProxyAddresses'
+  | 'SPS-LastColleagueAdded'
+  | 'SPS-OWAUrl'
+  | 'SPS-ResourceSID'
+  | 'SPS-ResourceAccountName'
+  | 'SPS-MasterAccountName'
+  | 'SPS-DistinguishedName'
+  | 'SPS-SourceObjectDN'
+  | 'SPS-LastKeywordAdded'
+  | 'SPS-StatusNotes'
+  | 'SPS-DisplayOrder'
+  | 'SPS-ClaimID'
+  | 'SPS-ClaimProviderID'
+  | 'SPS-ClaimProviderType'
+  | 'SPS-SavedAccountName'
+  | 'SPS-SavedSID'
+  | 'SPS-ObjectExists'
+  | 'SPS-PersonalSiteCapabilities'
+  | 'SPS-UserPrincipalName'
+  | 'SPS-O15FirstRunExperience'
+  | 'SPS-PersonalSiteInstantiationState'
+  | 'SPS-PersonalSiteFirstCreationTime'
+  | 'SPS-PersonalSiteLastCreationTime'
+  | 'SPS-PersonalSiteNumberOfRetries'
+  | 'SPS-PersonalSiteFirstCreationError'
+  | 'SPS-FeedIdentifier'
+  | 'SPS-HashTags'
+  | 'SPS-PrivacyPeople'
+  | 'SPS-EmailOptin'
+  | 'SPS-PrivacyActivity'
+  | 'SPS-PictureTimestamp'
+  | 'SPS-PicturePlaceholderState'
+  | 'SPS-PictureExchangeSyncState'
+  | 'SPS-MUILanguages'
+  | 'SPS-ContentLanguages'
+  | 'OfficeGraphEnabled'
+  | 'SPS-UserType'
+  | 'SPS-HideFromAddressLists'
+  | 'SPS-RecipientTypeDetails'
+  | 'DelveFlags'
+  | 'PulseMRUPeople'
+  | 'msOnline-ObjectId'
+  | 'SPS-PointPublishingUrl'
+  | 'SPS-TenantInstanceId'
+  | 'SPS-SharePointHomeExperienceState'
+  | 'SPS-MultiGeoFlags'
+  | 'PreferredDataLocation'
+  | 'PrivacyNotified'
+  | 'PrivacyNotifiedDate'
+  | 'O365'
+  | 'O365MigrationDate';
+
+export type UserProfile = {
+  AccountName: string;
+  Country: string;
+  DisplayName: string;
+  Email: string;
+  ExtendedManagers: {
+    results: string[];
+    __metadata: Metadata;
+  };
+  ExtendedReports: {
+    results: string[];
+    __metadata: Metadata;
+  };
+  FirstName: string;
+  IsFollowed: boolean;
+  LastName: string;
+  PersonalUrl: string;
+  PictureUrl: string;
+  Title: string;
+  UserName: string;
+  UserProfileProperties: {
+    results: {
+      Key: UserProfilePropKey;
+      Value: string;
+      ValueType: string;
+      __metadata: { type: string };
+    }[];
+  };
+  UserUrl: string;
+  __metadata: Metadata;
+};