@pnp/sp 2.7.0 → 2.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (309) hide show
  1. package/LICENSE +25 -25
  2. package/appcatalog/index.d.ts +8 -8
  3. package/appcatalog/index.js +30 -30
  4. package/appcatalog/types.d.ts +81 -81
  5. package/appcatalog/types.js +177 -177
  6. package/appcatalog/web.d.ts +16 -16
  7. package/appcatalog/web.js +6 -6
  8. package/attachments/index.d.ts +2 -2
  9. package/attachments/index.js +2 -2
  10. package/attachments/item.d.ts +12 -12
  11. package/attachments/item.js +4 -4
  12. package/attachments/types.d.ts +92 -92
  13. package/attachments/types.js +240 -240
  14. package/batch.d.ts +17 -17
  15. package/batch.js +223 -223
  16. package/batch.js.map +1 -1
  17. package/clientside-pages/funcs.d.ts +22 -22
  18. package/clientside-pages/funcs.js +25 -25
  19. package/clientside-pages/index.d.ts +2 -2
  20. package/clientside-pages/index.js +2 -2
  21. package/clientside-pages/types.d.ts +496 -494
  22. package/clientside-pages/types.d.ts.map +1 -1
  23. package/clientside-pages/types.js +1496 -1485
  24. package/clientside-pages/types.js.map +1 -1
  25. package/clientside-pages/web.d.ts +41 -41
  26. package/clientside-pages/web.js +57 -57
  27. package/column-defaults/folder.d.ts +27 -27
  28. package/column-defaults/folder.js +82 -82
  29. package/column-defaults/index.d.ts +3 -3
  30. package/column-defaults/index.js +2 -2
  31. package/column-defaults/list.d.ts +19 -19
  32. package/column-defaults/list.js +198 -198
  33. package/column-defaults/types.d.ts +21 -21
  34. package/column-defaults/types.js +1 -1
  35. package/comments/clientside-page.d.ts +57 -57
  36. package/comments/clientside-page.d.ts.map +1 -1
  37. package/comments/clientside-page.js +136 -136
  38. package/comments/index.d.ts +2 -2
  39. package/comments/index.js +2 -2
  40. package/comments/item.d.ts +29 -29
  41. package/comments/item.js +47 -47
  42. package/comments/types.d.ts +107 -107
  43. package/comments/types.d.ts.map +1 -1
  44. package/comments/types.js +145 -145
  45. package/comments/types.js.map +1 -1
  46. package/content-types/index.d.ts +4 -4
  47. package/content-types/index.js +4 -4
  48. package/content-types/item.d.ts +12 -12
  49. package/content-types/item.js +4 -4
  50. package/content-types/list.d.ts +12 -12
  51. package/content-types/list.js +4 -4
  52. package/content-types/types.d.ts +107 -107
  53. package/content-types/types.js +166 -166
  54. package/content-types/web.d.ts +12 -12
  55. package/content-types/web.js +4 -4
  56. package/decorators.d.ts +11 -11
  57. package/decorators.js +28 -28
  58. package/features/index.d.ts +3 -3
  59. package/features/index.js +3 -3
  60. package/features/site.d.ts +12 -12
  61. package/features/site.js +4 -4
  62. package/features/types.d.ts +47 -47
  63. package/features/types.js +109 -109
  64. package/features/web.d.ts +12 -12
  65. package/features/web.js +4 -4
  66. package/fields/index.d.ts +4 -4
  67. package/fields/index.js +4 -4
  68. package/fields/list.d.ts +12 -12
  69. package/fields/list.js +4 -4
  70. package/fields/types.d.ts +368 -361
  71. package/fields/types.d.ts.map +1 -1
  72. package/fields/types.js +624 -609
  73. package/fields/types.js.map +1 -1
  74. package/fields/web.d.ts +17 -17
  75. package/fields/web.js +5 -5
  76. package/files/folder.d.ts +12 -12
  77. package/files/folder.js +4 -4
  78. package/files/index.d.ts +4 -4
  79. package/files/index.js +4 -4
  80. package/files/item.d.ts +12 -12
  81. package/files/item.js +4 -4
  82. package/files/types.d.ts +421 -421
  83. package/files/types.js +853 -853
  84. package/files/types.js.map +1 -1
  85. package/files/web.d.ts +35 -35
  86. package/files/web.js +15 -15
  87. package/folders/index.d.ts +4 -4
  88. package/folders/index.js +4 -4
  89. package/folders/item.d.ts +9 -9
  90. package/folders/item.js +4 -4
  91. package/folders/list.d.ts +12 -12
  92. package/folders/list.js +4 -4
  93. package/folders/types.d.ts +207 -207
  94. package/folders/types.js +433 -433
  95. package/folders/types.js.map +1 -1
  96. package/folders/web.d.ts +39 -39
  97. package/folders/web.js +15 -15
  98. package/forms/index.d.ts +2 -2
  99. package/forms/index.js +2 -2
  100. package/forms/list.d.ts +9 -9
  101. package/forms/list.js +4 -4
  102. package/forms/types.d.ts +35 -35
  103. package/forms/types.js +41 -41
  104. package/hubsites/index.d.ts +12 -12
  105. package/hubsites/index.js +15 -15
  106. package/hubsites/site.d.ts +26 -26
  107. package/hubsites/site.js +39 -39
  108. package/hubsites/types.d.ts +55 -55
  109. package/hubsites/types.js +53 -53
  110. package/hubsites/web.d.ts +21 -21
  111. package/hubsites/web.js +23 -23
  112. package/index.d.ts +14 -14
  113. package/index.js +13 -13
  114. package/items/index.d.ts +2 -2
  115. package/items/index.js +2 -2
  116. package/items/list.d.ts +9 -9
  117. package/items/list.js +4 -4
  118. package/items/types.d.ts +226 -219
  119. package/items/types.d.ts.map +1 -1
  120. package/items/types.js +549 -511
  121. package/items/types.js.map +1 -1
  122. package/lists/index.d.ts +2 -2
  123. package/lists/index.js +2 -2
  124. package/lists/types.d.ts +495 -495
  125. package/lists/types.js +522 -522
  126. package/lists/types.js.map +1 -1
  127. package/lists/web.d.ts +43 -43
  128. package/lists/web.js +27 -27
  129. package/navigation/index.d.ts +8 -8
  130. package/navigation/index.js +14 -14
  131. package/navigation/types.d.ts +154 -154
  132. package/navigation/types.js +219 -219
  133. package/navigation/web.d.ts +13 -13
  134. package/navigation/web.js +4 -4
  135. package/odata.d.ts +5 -5
  136. package/odata.js +90 -90
  137. package/odata.js.map +1 -1
  138. package/operations.d.ts +9 -9
  139. package/operations.js +63 -63
  140. package/package.json +4 -4
  141. package/presets/all.d.ts +72 -72
  142. package/presets/all.js +72 -72
  143. package/presets/core.d.ts +11 -11
  144. package/presets/core.js +11 -11
  145. package/profiles/index.d.ts +7 -7
  146. package/profiles/index.js +13 -13
  147. package/profiles/types.d.ts +357 -357
  148. package/profiles/types.js +454 -454
  149. package/readme.md +21 -21
  150. package/regional-settings/content-type.d.ts +7 -7
  151. package/regional-settings/content-type.js +4 -4
  152. package/regional-settings/field.d.ts +7 -7
  153. package/regional-settings/field.js +4 -4
  154. package/regional-settings/funcs.d.ts +2 -2
  155. package/regional-settings/funcs.js +8 -8
  156. package/regional-settings/index.d.ts +6 -6
  157. package/regional-settings/index.js +6 -6
  158. package/regional-settings/list.d.ts +7 -7
  159. package/regional-settings/list.js +4 -4
  160. package/regional-settings/types.d.ts +111 -111
  161. package/regional-settings/types.js +159 -159
  162. package/regional-settings/user-custom-actions.d.ts +7 -7
  163. package/regional-settings/user-custom-actions.js +4 -4
  164. package/regional-settings/web.d.ts +12 -12
  165. package/regional-settings/web.js +7 -7
  166. package/related-items/index.d.ts +1 -1
  167. package/related-items/index.js +1 -1
  168. package/related-items/types.d.ts +76 -76
  169. package/related-items/types.js +103 -103
  170. package/related-items/web.d.ts +12 -12
  171. package/related-items/web.js +9 -9
  172. package/rest.d.ts +44 -44
  173. package/rest.js +72 -72
  174. package/search/index.d.ts +30 -30
  175. package/search/index.js +25 -25
  176. package/search/query.d.ts +62 -62
  177. package/search/query.js +302 -302
  178. package/search/suggest.d.ts +76 -76
  179. package/search/suggest.js +66 -66
  180. package/search/types.d.ts +426 -426
  181. package/search/types.js +57 -57
  182. package/security/funcs.d.ts +43 -43
  183. package/security/funcs.js +142 -142
  184. package/security/index.d.ts +4 -4
  185. package/security/index.js +4 -4
  186. package/security/item.d.ts +7 -7
  187. package/security/item.js +14 -14
  188. package/security/list.d.ts +7 -7
  189. package/security/list.js +14 -14
  190. package/security/types.d.ts +318 -318
  191. package/security/types.js +399 -399
  192. package/security/web.d.ts +9 -9
  193. package/security/web.js +15 -15
  194. package/sharepointqueryable.d.ts +135 -135
  195. package/sharepointqueryable.js +265 -265
  196. package/sharing/file.d.ts +18 -18
  197. package/sharing/file.d.ts.map +1 -1
  198. package/sharing/file.js +116 -15
  199. package/sharing/file.js.map +1 -1
  200. package/sharing/folder.d.ts +9 -9
  201. package/sharing/folder.js +136 -136
  202. package/sharing/funcs.d.ts +62 -62
  203. package/sharing/funcs.js +239 -239
  204. package/sharing/funcs.js.map +1 -1
  205. package/sharing/index.d.ts +5 -5
  206. package/sharing/index.js +5 -5
  207. package/sharing/item.d.ts +16 -16
  208. package/sharing/item.js +15 -15
  209. package/sharing/types.d.ts +583 -583
  210. package/sharing/types.js +113 -113
  211. package/sharing/web.d.ts +19 -19
  212. package/sharing/web.js +76 -76
  213. package/site-designs/index.d.ts +8 -8
  214. package/site-designs/index.js +14 -14
  215. package/site-designs/types.d.ts +319 -319
  216. package/site-designs/types.js +203 -203
  217. package/site-designs/web.d.ts +25 -25
  218. package/site-designs/web.js +11 -11
  219. package/site-groups/index.d.ts +2 -2
  220. package/site-groups/index.js +2 -2
  221. package/site-groups/types.d.ts +89 -89
  222. package/site-groups/types.js +125 -125
  223. package/site-groups/web.d.ts +40 -40
  224. package/site-groups/web.js +30 -30
  225. package/site-scripts/index.d.ts +9 -9
  226. package/site-scripts/index.js +15 -15
  227. package/site-scripts/list.d.ts +12 -12
  228. package/site-scripts/list.js +24 -24
  229. package/site-scripts/types.d.ts +183 -183
  230. package/site-scripts/types.js +141 -141
  231. package/site-scripts/web.d.ts +13 -13
  232. package/site-scripts/web.js +5 -5
  233. package/site-users/index.d.ts +2 -2
  234. package/site-users/index.js +2 -2
  235. package/site-users/types.d.ts +138 -138
  236. package/site-users/types.js +122 -122
  237. package/site-users/web.d.ts +31 -31
  238. package/site-users/web.js +27 -27
  239. package/sites/index.d.ts +7 -7
  240. package/sites/index.js +13 -13
  241. package/sites/types.d.ts +147 -147
  242. package/sites/types.js +321 -321
  243. package/social/index.d.ts +10 -10
  244. package/social/index.js +13 -13
  245. package/social/types.d.ts +309 -309
  246. package/social/types.js +322 -322
  247. package/sphttpclient.d.ts +18 -18
  248. package/sphttpclient.js +189 -189
  249. package/splibconfig.d.ts +22 -22
  250. package/splibconfig.js +13 -13
  251. package/sputilities/index.d.ts +7 -7
  252. package/sputilities/index.js +13 -13
  253. package/sputilities/types.d.ts +130 -130
  254. package/sputilities/types.js +118 -118
  255. package/subscriptions/index.d.ts +2 -2
  256. package/subscriptions/index.js +2 -2
  257. package/subscriptions/list.d.ts +13 -13
  258. package/subscriptions/list.js +4 -4
  259. package/subscriptions/types.d.ts +54 -54
  260. package/subscriptions/types.js +111 -111
  261. package/taxonomy/index.d.ts +7 -7
  262. package/taxonomy/index.js +13 -13
  263. package/taxonomy/types.d.ts +200 -200
  264. package/taxonomy/types.js +347 -347
  265. package/taxonomy/types.js.map +1 -1
  266. package/telemetry.d.ts +12 -12
  267. package/telemetry.js +48 -48
  268. package/types.d.ts +218 -218
  269. package/types.js +79 -79
  270. package/user-custom-actions/index.d.ts +4 -4
  271. package/user-custom-actions/index.js +4 -4
  272. package/user-custom-actions/list.d.ts +12 -12
  273. package/user-custom-actions/list.js +4 -4
  274. package/user-custom-actions/site.d.ts +12 -12
  275. package/user-custom-actions/site.js +4 -4
  276. package/user-custom-actions/types.d.ts +82 -82
  277. package/user-custom-actions/types.js +93 -93
  278. package/user-custom-actions/web.d.ts +15 -15
  279. package/user-custom-actions/web.js +4 -4
  280. package/utils/escapeQueryStrValue.d.ts +1 -1
  281. package/utils/escapeQueryStrValue.js +19 -19
  282. package/utils/extractweburl.d.ts +1 -1
  283. package/utils/extractweburl.js +15 -15
  284. package/utils/file-names.d.ts +17 -17
  285. package/utils/file-names.js +38 -38
  286. package/utils/metadata.d.ts +5 -5
  287. package/utils/metadata.js +5 -5
  288. package/utils/objectToSPKeyValueCollection.d.ts +20 -20
  289. package/utils/objectToSPKeyValueCollection.js +16 -16
  290. package/utils/toResourcePath.d.ts +7 -7
  291. package/utils/toResourcePath.js +6 -6
  292. package/utils/toabsoluteurl.d.ts +7 -7
  293. package/utils/toabsoluteurl.js +61 -61
  294. package/views/index.d.ts +2 -2
  295. package/views/index.js +2 -2
  296. package/views/list.d.ts +23 -23
  297. package/views/list.js +8 -8
  298. package/views/types.d.ts +140 -140
  299. package/views/types.js +184 -184
  300. package/webparts/file.d.ts +15 -15
  301. package/webparts/file.js +6 -6
  302. package/webparts/index.d.ts +2 -2
  303. package/webparts/index.js +2 -2
  304. package/webparts/types.d.ts +83 -83
  305. package/webparts/types.js +117 -117
  306. package/webs/index.d.ts +16 -16
  307. package/webs/index.js +16 -16
  308. package/webs/types.d.ts +210 -210
  309. package/webs/types.js +295 -295
package/items/types.d.ts CHANGED
@@ -1,220 +1,227 @@
1
- import { _SharePointQueryableInstance, ISharePointQueryableInstance, _SharePointQueryableCollection, ISharePointQueryable, IDeleteableWithETag } from "../sharepointqueryable.js";
2
- import { ITypedHash } from "@pnp/common";
3
- import { IListItemFormUpdateValue } from "../lists/types.js";
4
- import { IList } from "../lists/index.js";
5
- import { IResourcePath } from "../utils/toResourcePath.js";
6
- /**
7
- * Describes a collection of Item objects
8
- *
9
- */
10
- export declare class _Items extends _SharePointQueryableCollection {
11
- /**
12
- * Gets an Item by id
13
- *
14
- * @param id The integer id of the item to retrieve
15
- */
16
- getById(id: number): IItem;
17
- /**
18
- * Gets BCS Item by string id
19
- *
20
- * @param stringId The string id of the BCS item to retrieve
21
- */
22
- getItemByStringId(stringId: string): IItem;
23
- /**
24
- * Skips the specified number of items (https://msdn.microsoft.com/en-us/library/office/fp142385.aspx#sectionSection6)
25
- *
26
- * @param skip The starting id where the page should start, use with top to specify pages
27
- * @param reverse It true the PagedPrev=true parameter is added allowing backwards navigation in the collection
28
- */
29
- skip(skip: number, reverse?: boolean): this;
30
- /**
31
- * Gets a collection designed to aid in paging through data
32
- *
33
- */
34
- getPaged<T = any[]>(): Promise<PagedItemCollection<T>>;
35
- /**
36
- * Gets all the items in a list, regardless of count. Does not support batching or caching
37
- *
38
- * @param requestSize Number of items to return in each request (Default: 2000)
39
- * @param acceptHeader Allows for setting the value of the Accept header for SP 2013 support
40
- */
41
- getAll(requestSize?: number, acceptHeader?: string): Promise<any[]>;
42
- /**
43
- * Adds a new item to the collection
44
- *
45
- * @param properties The new items's properties
46
- * @param listItemEntityTypeFullName The type name of the list's entities
47
- */
48
- add(properties?: ITypedHash<any>, listItemEntityTypeFullName?: string): Promise<IItemAddResult>;
49
- /**
50
- * Ensures we have the proper list item entity type name, either from the value provided or from the list
51
- *
52
- * @param candidatelistItemEntityTypeFullName The potential type name
53
- */
54
- private ensureListItemEntityTypeName;
55
- }
56
- export interface IItems extends _Items {
57
- }
58
- export declare const Items: import("../sharepointqueryable.js").ISPInvokableFactory<IItems>;
59
- /**
60
- * Descrines a single Item instance
61
- *
62
- */
63
- export declare class _Item extends _SharePointQueryableInstance {
64
- delete: (this: ISharePointQueryable<any>, eTag?: string) => Promise<void>;
65
- /**
66
- * Gets the effective base permissions for the item
67
- *
68
- */
69
- get effectiveBasePermissions(): ISharePointQueryable;
70
- /**
71
- * Gets the effective base permissions for the item in a UI context
72
- *
73
- */
74
- get effectiveBasePermissionsForUI(): ISharePointQueryable;
75
- /**
76
- * Gets the field values for this list item in their HTML representation
77
- *
78
- */
79
- get fieldValuesAsHTML(): ISharePointQueryableInstance;
80
- /**
81
- * Gets the field values for this list item in their text representation
82
- *
83
- */
84
- get fieldValuesAsText(): ISharePointQueryableInstance;
85
- /**
86
- * Gets the field values for this list item for use in editing controls
87
- *
88
- */
89
- get fieldValuesForEdit(): ISharePointQueryableInstance;
90
- /**
91
- * Gets the collection of versions associated with this item
92
- */
93
- get versions(): IItemVersions;
94
- get list(): IList;
95
- /**
96
- * Updates this list instance with the supplied properties
97
- *
98
- * @param properties A plain object hash of values to update for the list
99
- * @param eTag Value used in the IF-Match header, by default "*"
100
- * @param listItemEntityTypeFullName The type name of the list's entities
101
- */
102
- update(properties: ITypedHash<any>, eTag?: string, listItemEntityTypeFullName?: string): Promise<IItemUpdateResult>;
103
- /**
104
- * Moves the list item to the Recycle Bin and returns the identifier of the new Recycle Bin item.
105
- */
106
- recycle(): Promise<string>;
107
- /**
108
- * Deletes the item object with options.
109
- *
110
- * @param parameters Specifies the options to use when deleting a item.
111
- */
112
- deleteWithParams(parameters: Partial<IItemDeleteParams>): Promise<void>;
113
- /**
114
- * Gets a string representation of the full URL to the WOPI frame.
115
- * If there is no associated WOPI application, or no associated action, an empty string is returned.
116
- *
117
- * @param action Display mode: 0: view, 1: edit, 2: mobileView, 3: interactivePreview
118
- */
119
- getWopiFrameUrl(action?: number): Promise<string>;
120
- /**
121
- * Validates and sets the values of the specified collection of fields for the list item.
122
- *
123
- * @param formValues The fields to change and their new values.
124
- * @param bNewDocumentUpdate true if the list item is a document being updated after upload; otherwise false.
125
- */
126
- validateUpdateListItem(formValues: IListItemFormUpdateValue[], bNewDocumentUpdate?: boolean): Promise<IListItemFormUpdateValue[]>;
127
- /**
128
- * Gets the parent information for this item's list and web
129
- */
130
- getParentInfos(): Promise<IItemParentInfos>;
131
- /**
132
- * Ensures we have the proper list item entity type name, either from the value provided or from the list
133
- *
134
- * @param candidatelistItemEntityTypeFullName The potential type name
135
- */
136
- private ensureListItemEntityTypeName;
137
- }
138
- export interface IItem extends _Item, IDeleteableWithETag {
139
- }
140
- export declare const Item: import("../sharepointqueryable.js").ISPInvokableFactory<IItem>;
141
- /**
142
- * Describes a collection of Version objects
143
- *
144
- */
145
- export declare class _ItemVersions extends _SharePointQueryableCollection {
146
- /**
147
- * Gets a version by id
148
- *
149
- * @param versionId The id of the version to retrieve
150
- */
151
- getById(versionId: number): IItemVersion;
152
- }
153
- export interface IItemVersions extends _ItemVersions {
154
- }
155
- export declare const ItemVersions: import("../sharepointqueryable.js").ISPInvokableFactory<IItemVersions>;
156
- /**
157
- * Describes a single Version instance
158
- *
159
- */
160
- export declare class _ItemVersion extends _SharePointQueryableInstance {
161
- delete: (this: ISharePointQueryable<any>, eTag?: string) => Promise<void>;
162
- }
163
- export interface IItemVersion extends _ItemVersion, IDeleteableWithETag {
164
- }
165
- export declare const ItemVersion: import("../sharepointqueryable.js").ISPInvokableFactory<IItemVersion>;
166
- /**
167
- * Provides paging functionality for list items
168
- */
169
- export declare class PagedItemCollection<T> {
170
- private parent;
171
- private nextUrl;
172
- results: T;
173
- constructor(parent: _Items, nextUrl: string, results: T);
174
- /**
175
- * If true there are more results available in the set, otherwise there are not
176
- */
177
- get hasNext(): boolean;
178
- /**
179
- * Gets the next set of results, or resolves to null if no results are available
180
- */
181
- getNext(): Promise<PagedItemCollection<T>>;
182
- }
183
- export interface IItemAddResult {
184
- item: IItem;
185
- data: any;
186
- }
187
- export interface IItemUpdateResult {
188
- item: IItem;
189
- data: IItemUpdateResultData;
190
- }
191
- export interface IItemUpdateResultData {
192
- "odata.etag": string;
193
- }
194
- export interface IItemDeleteParams {
195
- /**
196
- * If true, delete or recycle a file when the LockType
197
- * value is SPLockType.Shared or SPLockType.None.
198
- * When false, delete or recycle the file when
199
- * the LockType value SPLockType.None.
200
- */
201
- BypassSharedLock: boolean;
202
- }
203
- export interface IItemParentInfos {
204
- Item: {
205
- Id: string;
206
- };
207
- ParentList: {
208
- Id: string;
209
- RootFolderServerRelativePath: IResourcePath;
210
- RootFolderServerRelativeUrl: string;
211
- RootFolderUniqueId: string;
212
- };
213
- ParentWeb: {
214
- Id: string;
215
- ServerRelativePath: IResourcePath;
216
- ServerRelativeUrl: string;
217
- Url: string;
218
- };
219
- }
1
+ import { _SharePointQueryableInstance, ISharePointQueryableInstance, _SharePointQueryableCollection, ISharePointQueryable, IDeleteableWithETag } from "../sharepointqueryable.js";
2
+ import { ITypedHash } from "@pnp/common";
3
+ import { IListItemFormUpdateValue } from "../lists/types.js";
4
+ import { IList } from "../lists/index.js";
5
+ import { IResourcePath } from "../utils/toResourcePath.js";
6
+ /**
7
+ * Describes a collection of Item objects
8
+ *
9
+ */
10
+ export declare class _Items extends _SharePointQueryableCollection {
11
+ /**
12
+ * Gets an Item by id
13
+ *
14
+ * @param id The integer id of the item to retrieve
15
+ */
16
+ getById(id: number): IItem;
17
+ /**
18
+ * Gets BCS Item by string id
19
+ *
20
+ * @param stringId The string id of the BCS item to retrieve
21
+ */
22
+ getItemByStringId(stringId: string): IItem;
23
+ /**
24
+ * Skips the specified number of items (https://msdn.microsoft.com/en-us/library/office/fp142385.aspx#sectionSection6)
25
+ *
26
+ * @param skip The starting id where the page should start, use with top to specify pages
27
+ * @param reverse It true the PagedPrev=true parameter is added allowing backwards navigation in the collection
28
+ */
29
+ skip(skip: number, reverse?: boolean): this;
30
+ /**
31
+ * Gets a collection designed to aid in paging through data
32
+ *
33
+ */
34
+ getPaged<T = any[]>(): Promise<PagedItemCollection<T>>;
35
+ /**
36
+ * Gets all the items in a list, regardless of count. Does not support batching or caching
37
+ *
38
+ * @param requestSize Number of items to return in each request (Default: 2000)
39
+ * @param acceptHeader Allows for setting the value of the Accept header for SP 2013 support
40
+ */
41
+ getAll(requestSize?: number, acceptHeader?: string): Promise<any[]>;
42
+ /**
43
+ * Adds a new item to the collection
44
+ *
45
+ * @param properties The new items's properties
46
+ * @param listItemEntityTypeFullName The type name of the list's entities
47
+ */
48
+ add(properties?: ITypedHash<any>, listItemEntityTypeFullName?: string): Promise<IItemAddResult>;
49
+ /**
50
+ * Ensures we have the proper list item entity type name, either from the value provided or from the list
51
+ *
52
+ * @param candidatelistItemEntityTypeFullName The potential type name
53
+ */
54
+ private ensureListItemEntityTypeName;
55
+ }
56
+ export interface IItems extends _Items {
57
+ }
58
+ export declare const Items: import("../sharepointqueryable.js").ISPInvokableFactory<IItems>;
59
+ /**
60
+ * Descrines a single Item instance
61
+ *
62
+ */
63
+ export declare class _Item extends _SharePointQueryableInstance {
64
+ delete: (this: ISharePointQueryable<any>, eTag?: string) => Promise<void>;
65
+ /**
66
+ * Gets the effective base permissions for the item
67
+ *
68
+ */
69
+ get effectiveBasePermissions(): ISharePointQueryable;
70
+ /**
71
+ * Gets the effective base permissions for the item in a UI context
72
+ *
73
+ */
74
+ get effectiveBasePermissionsForUI(): ISharePointQueryable;
75
+ /**
76
+ * Gets the field values for this list item in their HTML representation
77
+ *
78
+ */
79
+ get fieldValuesAsHTML(): ISharePointQueryableInstance;
80
+ /**
81
+ * Gets the field values for this list item in their text representation
82
+ *
83
+ */
84
+ get fieldValuesAsText(): ISharePointQueryableInstance;
85
+ /**
86
+ * Gets the field values for this list item for use in editing controls
87
+ *
88
+ */
89
+ get fieldValuesForEdit(): ISharePointQueryableInstance;
90
+ /**
91
+ * Gets the collection of versions associated with this item
92
+ */
93
+ get versions(): IItemVersions;
94
+ get list(): IList;
95
+ /**
96
+ * Updates this list instance with the supplied properties
97
+ *
98
+ * @param properties A plain object hash of values to update for the list
99
+ * @param eTag Value used in the IF-Match header, by default "*"
100
+ * @param listItemEntityTypeFullName The type name of the list's entities
101
+ */
102
+ update(properties: ITypedHash<any>, eTag?: string, listItemEntityTypeFullName?: string): Promise<IItemUpdateResult>;
103
+ /**
104
+ * Moves the list item to the Recycle Bin and returns the identifier of the new Recycle Bin item.
105
+ */
106
+ recycle(): Promise<string>;
107
+ /**
108
+ * Deletes the item object with options.
109
+ *
110
+ * @param parameters Specifies the options to use when deleting a item.
111
+ */
112
+ deleteWithParams(parameters: Partial<IItemDeleteParams>): Promise<void>;
113
+ /**
114
+ * Gets a string representation of the full URL to the WOPI frame.
115
+ * If there is no associated WOPI application, or no associated action, an empty string is returned.
116
+ *
117
+ * @param action Display mode: 0: view, 1: edit, 2: mobileView, 3: interactivePreview
118
+ */
119
+ getWopiFrameUrl(action?: number): Promise<string>;
120
+ /**
121
+ * Validates and sets the values of the specified collection of fields for the list item.
122
+ *
123
+ * @param formValues The fields to change and their new values.
124
+ * @param bNewDocumentUpdate true if the list item is a document being updated after upload; otherwise false.
125
+ */
126
+ validateUpdateListItem(formValues: IListItemFormUpdateValue[], bNewDocumentUpdate?: boolean): Promise<IListItemFormUpdateValue[]>;
127
+ /**
128
+ * Gets the parent information for this item's list and web
129
+ */
130
+ getParentInfos(): Promise<IItemParentInfos>;
131
+ setImageField(fieldName: string, imageName: string, imageContent: any): Promise<any>;
132
+ /**
133
+ * Ensures we have the proper list item entity type name, either from the value provided or from the list
134
+ *
135
+ * @param candidatelistItemEntityTypeFullName The potential type name
136
+ */
137
+ private ensureListItemEntityTypeName;
138
+ }
139
+ export interface IItem extends _Item, IDeleteableWithETag {
140
+ }
141
+ export declare const Item: import("../sharepointqueryable.js").ISPInvokableFactory<IItem>;
142
+ /**
143
+ * Describes a collection of Version objects
144
+ *
145
+ */
146
+ export declare class _ItemVersions extends _SharePointQueryableCollection {
147
+ /**
148
+ * Gets a version by id
149
+ *
150
+ * @param versionId The id of the version to retrieve
151
+ */
152
+ getById(versionId: number): IItemVersion;
153
+ }
154
+ export interface IItemVersions extends _ItemVersions {
155
+ }
156
+ export declare const ItemVersions: import("../sharepointqueryable.js").ISPInvokableFactory<IItemVersions>;
157
+ /**
158
+ * Describes a single Version instance
159
+ *
160
+ */
161
+ export declare class _ItemVersion extends _SharePointQueryableInstance {
162
+ delete: (this: ISharePointQueryable<any>, eTag?: string) => Promise<void>;
163
+ }
164
+ export interface IItemVersion extends _ItemVersion, IDeleteableWithETag {
165
+ }
166
+ export declare const ItemVersion: import("../sharepointqueryable.js").ISPInvokableFactory<IItemVersion>;
167
+ /**
168
+ * Provides paging functionality for list items
169
+ */
170
+ export declare class PagedItemCollection<T> {
171
+ private parent;
172
+ private nextUrl;
173
+ results: T;
174
+ constructor(parent: _Items, nextUrl: string, results: T);
175
+ /**
176
+ * If true there are more results available in the set, otherwise there are not
177
+ */
178
+ get hasNext(): boolean;
179
+ /**
180
+ * Gets the next set of results, or resolves to null if no results are available
181
+ */
182
+ getNext(): Promise<PagedItemCollection<T>>;
183
+ }
184
+ export interface IItemAddResult {
185
+ item: IItem;
186
+ data: any;
187
+ }
188
+ export interface IItemUpdateResult {
189
+ item: IItem;
190
+ data: IItemUpdateResultData;
191
+ }
192
+ export interface IItemUpdateResultData {
193
+ "odata.etag": string;
194
+ }
195
+ export interface IItemImageUploadResult {
196
+ Name: string;
197
+ ServerRelativeUrl: string;
198
+ UniqueId: string;
199
+ }
200
+ export interface IItemDeleteParams {
201
+ /**
202
+ * If true, delete or recycle a file when the LockType
203
+ * value is SPLockType.Shared or SPLockType.None.
204
+ * When false, delete or recycle the file when
205
+ * the LockType value SPLockType.None.
206
+ */
207
+ BypassSharedLock: boolean;
208
+ }
209
+ export interface IItemParentInfos {
210
+ Item: {
211
+ Id: string;
212
+ };
213
+ ParentList: {
214
+ Id: string;
215
+ Title: string;
216
+ RootFolderServerRelativePath: IResourcePath;
217
+ RootFolderServerRelativeUrl: string;
218
+ RootFolderUniqueId: string;
219
+ };
220
+ ParentWeb: {
221
+ Id: string;
222
+ ServerRelativePath: IResourcePath;
223
+ ServerRelativeUrl: string;
224
+ Url: string;
225
+ };
226
+ }
220
227
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/items/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,4BAA4B,EAC5B,4BAA4B,EAC5B,8BAA8B,EAC9B,oBAAoB,EAIpB,mBAAmB,EACtB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAU,UAAU,EAAO,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,wBAAwB,EAAQ,MAAM,mBAAmB,CAAC;AAEnE,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAM1C,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D;;;GAGG;AACH,qBACa,MAAO,SAAQ,8BAA8B;IAEtD;;;;MAIE;IACK,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,KAAK;IAIjC;;;;OAIG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK;IAKjD;;;;;OAKG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,UAAQ,GAAG,IAAI;IAShD;;;OAGG;IAEI,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAI7D;;;;;OAKG;IAEI,MAAM,CAAC,WAAW,SAAO,EAAE,YAAY,SAAsC,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IA+CrG;;;;;OAKG;IAEU,GAAG,CAAC,UAAU,GAAE,UAAU,CAAC,GAAG,CAAM,EAAE,0BAA0B,GAAE,MAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAoBtH;;;;OAIG;YACW,4BAA4B;CAM7C;AACD,MAAM,WAAW,MAAO,SAAQ,MAAM;CAAI;AAC1C,eAAO,MAAM,KAAK,iEAAqC,CAAC;AAExD;;;GAGG;AACH,qBAAa,KAAM,SAAQ,4BAA4B;IAE5C,MAAM,oEAA2B;IAExC;;;OAGG;IACH,IAAW,wBAAwB,IAAI,oBAAoB,CAE1D;IAED;;;OAGG;IACH,IAAW,6BAA6B,IAAI,oBAAoB,CAE/D;IAED;;;OAGG;IACH,IAAW,iBAAiB,IAAI,4BAA4B,CAE3D;IAED;;;OAGG;IACH,IAAW,iBAAiB,IAAI,4BAA4B,CAE3D;IAED;;;OAGG;IACH,IAAW,kBAAkB,IAAI,4BAA4B,CAE5D;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,aAAa,CAEnC;IAED,IAAW,IAAI,IAAI,KAAK,CAEvB;IAED;;;;;;OAMG;IACU,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,SAAM,EAAE,0BAA0B,GAAE,MAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAsBnI;;OAEG;IAEI,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAIjC;;;;OAIG;IAEU,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpF;;;;;OAKG;IAEU,eAAe,CAAC,MAAM,SAAI,GAAG,OAAO,CAAC,MAAM,CAAC;IAczD;;;;;OAKG;IAEI,sBAAsB,CAAC,UAAU,EAAE,wBAAwB,EAAE,EAAE,kBAAkB,UAAQ,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAItI;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAqCxD;;;;OAIG;YACW,4BAA4B;CAM7C;AACD,MAAM,WAAW,KAAM,SAAQ,KAAK,EAAE,mBAAmB;CAAI;AAC7D,eAAO,MAAM,IAAI,gEAAmC,CAAC;AAErD;;;GAGG;AACH,qBACa,aAAc,SAAQ,8BAA8B;IAC7D;;;;OAIG;IACI,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY;CAGlD;AACD,MAAM,WAAW,aAAc,SAAQ,aAAa;CAAI;AACxD,eAAO,MAAM,YAAY,wEAAmD,CAAC;AAE7E;;;GAGG;AACH,qBAAa,YAAa,SAAQ,4BAA4B;IACnD,MAAM,oEAA4B;CAC5C;AACD,MAAM,WAAW,YAAa,SAAQ,YAAY,EAAE,mBAAmB;CAAI;AAC3E,eAAO,MAAM,WAAW,uEAAiD,CAAC;AAE1E;;GAEG;AACH,qBAAa,mBAAmB,CAAC,CAAC;IAElB,OAAO,CAAC,MAAM;IAAU,OAAO,CAAC,OAAO;IAAiB,OAAO,EAAE,CAAC;gBAA1D,MAAM,EAAE,MAAM,EAAU,OAAO,EAAE,MAAM,EAAS,OAAO,EAAE,CAAC;IAE9E;;OAEG;IACH,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED;;OAEG;IACI,OAAO,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;CASpD;AAoCD,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,EAAE,qBAAqB,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAqB;IAClC,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAE9B;;;;;OAKG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE;QACF,EAAE,EAAE,MAAM,CAAC;KACd,CAAC;IACF,UAAU,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,4BAA4B,EAAE,aAAa,CAAC;QAC5C,2BAA2B,EAAE,MAAM,CAAC;QACpC,kBAAkB,EAAE,MAAM,CAAC;KAC9B,CAAC;IACF,SAAS,EAAE;QACP,EAAE,EAAE,MAAM,CAAC;QACX,kBAAkB,EAAE,aAAa,CAAC;QAClC,iBAAiB,EAAE,MAAM,CAAC;QAC1B,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;CACL"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/sp/items/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,4BAA4B,EAC5B,4BAA4B,EAC5B,8BAA8B,EAC9B,oBAAoB,EAIpB,mBAAmB,EACtB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAU,UAAU,EAAO,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,wBAAwB,EAAQ,MAAM,mBAAmB,CAAC;AAEnE,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAM1C,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAI3D;;;GAGG;AACH,qBACa,MAAO,SAAQ,8BAA8B;IAEtD;;;;MAIE;IACK,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,KAAK;IAIjC;;;;OAIG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK;IAKjD;;;;;OAKG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,UAAQ,GAAG,IAAI;IAShD;;;OAGG;IAEI,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAI7D;;;;;OAKG;IAEI,MAAM,CAAC,WAAW,SAAO,EAAE,YAAY,SAAsC,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IA+CrG;;;;;OAKG;IAEU,GAAG,CAAC,UAAU,GAAE,UAAU,CAAC,GAAG,CAAM,EAAE,0BAA0B,GAAE,MAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAoBtH;;;;OAIG;YACW,4BAA4B;CAM7C;AACD,MAAM,WAAW,MAAO,SAAQ,MAAM;CAAI;AAC1C,eAAO,MAAM,KAAK,iEAAqC,CAAC;AAExD;;;GAGG;AACH,qBAAa,KAAM,SAAQ,4BAA4B;IAE5C,MAAM,oEAA2B;IAExC;;;OAGG;IACH,IAAW,wBAAwB,IAAI,oBAAoB,CAE1D;IAED;;;OAGG;IACH,IAAW,6BAA6B,IAAI,oBAAoB,CAE/D;IAED;;;OAGG;IACH,IAAW,iBAAiB,IAAI,4BAA4B,CAE3D;IAED;;;OAGG;IACH,IAAW,iBAAiB,IAAI,4BAA4B,CAE3D;IAED;;;OAGG;IACH,IAAW,kBAAkB,IAAI,4BAA4B,CAE5D;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,aAAa,CAEnC;IAED,IAAW,IAAI,IAAI,KAAK,CAEvB;IAED;;;;;;OAMG;IACU,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,SAAM,EAAE,0BAA0B,GAAE,MAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAsBnI;;OAEG;IAEI,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAIjC;;;;OAIG;IAEU,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpF;;;;;OAKG;IAEU,eAAe,CAAC,MAAM,SAAI,GAAG,OAAO,CAAC,MAAM,CAAC;IAczD;;;;;OAKG;IAEI,sBAAsB,CAAC,UAAU,EAAE,wBAAwB,EAAE,EAAE,kBAAkB,UAAQ,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC;IAItI;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAuC3C,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IA+BjG;;;;OAIG;YACW,4BAA4B;CAM7C;AACD,MAAM,WAAW,KAAM,SAAQ,KAAK,EAAE,mBAAmB;CAAI;AAC7D,eAAO,MAAM,IAAI,gEAAmC,CAAC;AAErD;;;GAGG;AACH,qBACa,aAAc,SAAQ,8BAA8B;IAC7D;;;;OAIG;IACI,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,YAAY;CAGlD;AACD,MAAM,WAAW,aAAc,SAAQ,aAAa;CAAI;AACxD,eAAO,MAAM,YAAY,wEAAmD,CAAC;AAE7E;;;GAGG;AACH,qBAAa,YAAa,SAAQ,4BAA4B;IACnD,MAAM,oEAA4B;CAC5C;AACD,MAAM,WAAW,YAAa,SAAQ,YAAY,EAAE,mBAAmB;CAAI;AAC3E,eAAO,MAAM,WAAW,uEAAiD,CAAC;AAE1E;;GAEG;AACH,qBAAa,mBAAmB,CAAC,CAAC;IAElB,OAAO,CAAC,MAAM;IAAU,OAAO,CAAC,OAAO;IAAiB,OAAO,EAAE,CAAC;gBAA1D,MAAM,EAAE,MAAM,EAAU,OAAO,EAAE,MAAM,EAAS,OAAO,EAAE,CAAC;IAE9E;;OAEG;IACH,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED;;OAEG;IACI,OAAO,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;CASpD;AAoCD,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,KAAK,CAAC;IACZ,IAAI,EAAE,qBAAqB,CAAC;CAC/B;AAED,MAAM,WAAW,qBAAqB;IAClC,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAE9B;;;;;OAKG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE;QACF,EAAE,EAAE,MAAM,CAAC;KACd,CAAC;IACF,UAAU,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,4BAA4B,EAAE,aAAa,CAAC;QAC5C,2BAA2B,EAAE,MAAM,CAAC;QACpC,kBAAkB,EAAE,MAAM,CAAC;KAC9B,CAAC;IACF,SAAS,EAAE;QACP,EAAE,EAAE,MAAM,CAAC;QACX,kBAAkB,EAAE,aAAa,CAAC;QAClC,iBAAiB,EAAE,MAAM,CAAC;QAC1B,GAAG,EAAE,MAAM,CAAC;KACf,CAAC;CACL"}