@pnp/sp 2.10.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 (294) 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/clientside-pages/funcs.d.ts +22 -22
  17. package/clientside-pages/funcs.js +25 -25
  18. package/clientside-pages/index.d.ts +2 -2
  19. package/clientside-pages/index.js +2 -2
  20. package/clientside-pages/types.d.ts +496 -496
  21. package/clientside-pages/types.js +1496 -1496
  22. package/clientside-pages/web.d.ts +41 -41
  23. package/clientside-pages/web.js +57 -57
  24. package/column-defaults/folder.d.ts +27 -27
  25. package/column-defaults/folder.js +82 -82
  26. package/column-defaults/index.d.ts +3 -3
  27. package/column-defaults/index.js +2 -2
  28. package/column-defaults/list.d.ts +19 -19
  29. package/column-defaults/list.js +198 -198
  30. package/column-defaults/types.d.ts +21 -21
  31. package/column-defaults/types.js +1 -1
  32. package/comments/clientside-page.d.ts +57 -57
  33. package/comments/clientside-page.d.ts.map +1 -1
  34. package/comments/clientside-page.js +136 -136
  35. package/comments/index.d.ts +2 -2
  36. package/comments/index.js +2 -2
  37. package/comments/item.d.ts +29 -29
  38. package/comments/item.js +47 -47
  39. package/comments/types.d.ts +107 -107
  40. package/comments/types.d.ts.map +1 -1
  41. package/comments/types.js +145 -145
  42. package/comments/types.js.map +1 -1
  43. package/content-types/index.d.ts +4 -4
  44. package/content-types/index.js +4 -4
  45. package/content-types/item.d.ts +12 -12
  46. package/content-types/item.js +4 -4
  47. package/content-types/list.d.ts +12 -12
  48. package/content-types/list.js +4 -4
  49. package/content-types/types.d.ts +107 -107
  50. package/content-types/types.js +166 -166
  51. package/content-types/web.d.ts +12 -12
  52. package/content-types/web.js +4 -4
  53. package/decorators.d.ts +11 -11
  54. package/decorators.js +28 -28
  55. package/features/index.d.ts +3 -3
  56. package/features/index.js +3 -3
  57. package/features/site.d.ts +12 -12
  58. package/features/site.js +4 -4
  59. package/features/types.d.ts +47 -47
  60. package/features/types.js +109 -109
  61. package/features/web.d.ts +12 -12
  62. package/features/web.js +4 -4
  63. package/fields/index.d.ts +4 -4
  64. package/fields/index.js +4 -4
  65. package/fields/list.d.ts +12 -12
  66. package/fields/list.js +4 -4
  67. package/fields/types.d.ts +368 -368
  68. package/fields/types.js +624 -624
  69. package/fields/web.d.ts +17 -17
  70. package/fields/web.js +5 -5
  71. package/files/folder.d.ts +12 -12
  72. package/files/folder.js +4 -4
  73. package/files/index.d.ts +4 -4
  74. package/files/index.js +4 -4
  75. package/files/item.d.ts +12 -12
  76. package/files/item.js +4 -4
  77. package/files/types.d.ts +421 -421
  78. package/files/types.js +853 -853
  79. package/files/web.d.ts +35 -35
  80. package/files/web.js +15 -15
  81. package/folders/index.d.ts +4 -4
  82. package/folders/index.js +4 -4
  83. package/folders/item.d.ts +9 -9
  84. package/folders/item.js +4 -4
  85. package/folders/list.d.ts +12 -12
  86. package/folders/list.js +4 -4
  87. package/folders/types.d.ts +207 -207
  88. package/folders/types.js +433 -433
  89. package/folders/web.d.ts +39 -39
  90. package/folders/web.js +15 -15
  91. package/forms/index.d.ts +2 -2
  92. package/forms/index.js +2 -2
  93. package/forms/list.d.ts +9 -9
  94. package/forms/list.js +4 -4
  95. package/forms/types.d.ts +35 -35
  96. package/forms/types.js +41 -41
  97. package/hubsites/index.d.ts +12 -12
  98. package/hubsites/index.js +15 -15
  99. package/hubsites/site.d.ts +26 -26
  100. package/hubsites/site.js +39 -39
  101. package/hubsites/types.d.ts +55 -55
  102. package/hubsites/types.js +53 -53
  103. package/hubsites/web.d.ts +21 -21
  104. package/hubsites/web.js +23 -23
  105. package/index.d.ts +14 -14
  106. package/index.js +13 -13
  107. package/items/index.d.ts +2 -2
  108. package/items/index.js +2 -2
  109. package/items/list.d.ts +9 -9
  110. package/items/list.js +4 -4
  111. package/items/types.d.ts +226 -226
  112. package/items/types.js +549 -549
  113. package/lists/index.d.ts +2 -2
  114. package/lists/index.js +2 -2
  115. package/lists/types.d.ts +495 -495
  116. package/lists/types.js +522 -522
  117. package/lists/web.d.ts +43 -43
  118. package/lists/web.js +27 -27
  119. package/navigation/index.d.ts +8 -8
  120. package/navigation/index.js +14 -14
  121. package/navigation/types.d.ts +154 -154
  122. package/navigation/types.js +219 -219
  123. package/navigation/web.d.ts +13 -13
  124. package/navigation/web.js +4 -4
  125. package/odata.d.ts +5 -5
  126. package/odata.js +90 -90
  127. package/operations.d.ts +9 -9
  128. package/operations.js +63 -63
  129. package/package.json +4 -4
  130. package/presets/all.d.ts +72 -72
  131. package/presets/all.js +72 -72
  132. package/presets/core.d.ts +11 -11
  133. package/presets/core.js +11 -11
  134. package/profiles/index.d.ts +7 -7
  135. package/profiles/index.js +13 -13
  136. package/profiles/types.d.ts +357 -357
  137. package/profiles/types.js +454 -454
  138. package/readme.md +21 -21
  139. package/regional-settings/content-type.d.ts +7 -7
  140. package/regional-settings/content-type.js +4 -4
  141. package/regional-settings/field.d.ts +7 -7
  142. package/regional-settings/field.js +4 -4
  143. package/regional-settings/funcs.d.ts +2 -2
  144. package/regional-settings/funcs.js +8 -8
  145. package/regional-settings/index.d.ts +6 -6
  146. package/regional-settings/index.js +6 -6
  147. package/regional-settings/list.d.ts +7 -7
  148. package/regional-settings/list.js +4 -4
  149. package/regional-settings/types.d.ts +111 -111
  150. package/regional-settings/types.js +159 -159
  151. package/regional-settings/user-custom-actions.d.ts +7 -7
  152. package/regional-settings/user-custom-actions.js +4 -4
  153. package/regional-settings/web.d.ts +12 -12
  154. package/regional-settings/web.js +7 -7
  155. package/related-items/index.d.ts +1 -1
  156. package/related-items/index.js +1 -1
  157. package/related-items/types.d.ts +76 -76
  158. package/related-items/types.js +103 -103
  159. package/related-items/web.d.ts +12 -12
  160. package/related-items/web.js +9 -9
  161. package/rest.d.ts +44 -44
  162. package/rest.js +72 -72
  163. package/search/index.d.ts +30 -30
  164. package/search/index.js +25 -25
  165. package/search/query.d.ts +62 -62
  166. package/search/query.js +302 -302
  167. package/search/suggest.d.ts +76 -76
  168. package/search/suggest.js +66 -66
  169. package/search/types.d.ts +426 -426
  170. package/search/types.js +57 -57
  171. package/security/funcs.d.ts +43 -43
  172. package/security/funcs.js +142 -142
  173. package/security/index.d.ts +4 -4
  174. package/security/index.js +4 -4
  175. package/security/item.d.ts +7 -7
  176. package/security/item.js +14 -14
  177. package/security/list.d.ts +7 -7
  178. package/security/list.js +14 -14
  179. package/security/types.d.ts +318 -318
  180. package/security/types.js +399 -399
  181. package/security/web.d.ts +9 -9
  182. package/security/web.js +15 -15
  183. package/sharepointqueryable.d.ts +135 -135
  184. package/sharepointqueryable.js +265 -265
  185. package/sharing/file.d.ts +18 -18
  186. package/sharing/file.js +116 -116
  187. package/sharing/folder.d.ts +9 -9
  188. package/sharing/folder.js +136 -136
  189. package/sharing/funcs.d.ts +62 -62
  190. package/sharing/funcs.js +239 -239
  191. package/sharing/index.d.ts +5 -5
  192. package/sharing/index.js +5 -5
  193. package/sharing/item.d.ts +16 -16
  194. package/sharing/item.js +15 -15
  195. package/sharing/types.d.ts +583 -583
  196. package/sharing/types.js +113 -113
  197. package/sharing/web.d.ts +19 -19
  198. package/sharing/web.js +76 -76
  199. package/site-designs/index.d.ts +8 -8
  200. package/site-designs/index.js +14 -14
  201. package/site-designs/types.d.ts +319 -319
  202. package/site-designs/types.js +203 -203
  203. package/site-designs/web.d.ts +25 -25
  204. package/site-designs/web.js +11 -11
  205. package/site-groups/index.d.ts +2 -2
  206. package/site-groups/index.js +2 -2
  207. package/site-groups/types.d.ts +89 -89
  208. package/site-groups/types.js +125 -125
  209. package/site-groups/web.d.ts +40 -40
  210. package/site-groups/web.js +30 -30
  211. package/site-scripts/index.d.ts +9 -9
  212. package/site-scripts/index.js +15 -15
  213. package/site-scripts/list.d.ts +12 -12
  214. package/site-scripts/list.js +24 -24
  215. package/site-scripts/types.d.ts +183 -183
  216. package/site-scripts/types.js +141 -141
  217. package/site-scripts/web.d.ts +13 -13
  218. package/site-scripts/web.js +5 -5
  219. package/site-users/index.d.ts +2 -2
  220. package/site-users/index.js +2 -2
  221. package/site-users/types.d.ts +138 -138
  222. package/site-users/types.js +122 -122
  223. package/site-users/web.d.ts +31 -31
  224. package/site-users/web.js +27 -27
  225. package/sites/index.d.ts +7 -7
  226. package/sites/index.js +13 -13
  227. package/sites/types.d.ts +147 -147
  228. package/sites/types.js +321 -321
  229. package/social/index.d.ts +10 -10
  230. package/social/index.js +13 -13
  231. package/social/types.d.ts +309 -309
  232. package/social/types.js +322 -322
  233. package/sphttpclient.d.ts +18 -18
  234. package/sphttpclient.js +189 -189
  235. package/splibconfig.d.ts +22 -22
  236. package/splibconfig.js +13 -13
  237. package/sputilities/index.d.ts +7 -7
  238. package/sputilities/index.js +13 -13
  239. package/sputilities/types.d.ts +130 -130
  240. package/sputilities/types.js +118 -118
  241. package/subscriptions/index.d.ts +2 -2
  242. package/subscriptions/index.js +2 -2
  243. package/subscriptions/list.d.ts +13 -13
  244. package/subscriptions/list.js +4 -4
  245. package/subscriptions/types.d.ts +54 -54
  246. package/subscriptions/types.js +111 -111
  247. package/taxonomy/index.d.ts +7 -7
  248. package/taxonomy/index.js +13 -13
  249. package/taxonomy/types.d.ts +200 -200
  250. package/taxonomy/types.js +347 -347
  251. package/telemetry.d.ts +12 -12
  252. package/telemetry.js +48 -48
  253. package/types.d.ts +218 -218
  254. package/types.js +79 -79
  255. package/user-custom-actions/index.d.ts +4 -4
  256. package/user-custom-actions/index.js +4 -4
  257. package/user-custom-actions/list.d.ts +12 -12
  258. package/user-custom-actions/list.js +4 -4
  259. package/user-custom-actions/site.d.ts +12 -12
  260. package/user-custom-actions/site.js +4 -4
  261. package/user-custom-actions/types.d.ts +82 -82
  262. package/user-custom-actions/types.js +93 -93
  263. package/user-custom-actions/web.d.ts +15 -15
  264. package/user-custom-actions/web.js +4 -4
  265. package/utils/escapeQueryStrValue.d.ts +1 -1
  266. package/utils/escapeQueryStrValue.js +19 -19
  267. package/utils/extractweburl.d.ts +1 -1
  268. package/utils/extractweburl.js +15 -15
  269. package/utils/file-names.d.ts +17 -17
  270. package/utils/file-names.js +38 -38
  271. package/utils/metadata.d.ts +5 -5
  272. package/utils/metadata.js +5 -5
  273. package/utils/objectToSPKeyValueCollection.d.ts +20 -20
  274. package/utils/objectToSPKeyValueCollection.js +16 -16
  275. package/utils/toResourcePath.d.ts +7 -7
  276. package/utils/toResourcePath.js +6 -6
  277. package/utils/toabsoluteurl.d.ts +7 -7
  278. package/utils/toabsoluteurl.js +61 -61
  279. package/views/index.d.ts +2 -2
  280. package/views/index.js +2 -2
  281. package/views/list.d.ts +23 -23
  282. package/views/list.js +8 -8
  283. package/views/types.d.ts +140 -140
  284. package/views/types.js +184 -184
  285. package/webparts/file.d.ts +15 -15
  286. package/webparts/file.js +6 -6
  287. package/webparts/index.d.ts +2 -2
  288. package/webparts/index.js +2 -2
  289. package/webparts/types.d.ts +83 -83
  290. package/webparts/types.js +117 -117
  291. package/webs/index.d.ts +16 -16
  292. package/webs/index.js +16 -16
  293. package/webs/types.d.ts +210 -210
  294. package/webs/types.js +295 -295
package/security/web.d.ts CHANGED
@@ -1,10 +1,10 @@
1
- import { IRoleDefinitions, ISecurableMethods } from "./types.js";
2
- declare module "../webs/types" {
3
- interface _Web extends ISecurableMethods {
4
- roleDefinitions: IRoleDefinitions;
5
- }
6
- interface IWeb extends ISecurableMethods {
7
- roleDefinitions: IRoleDefinitions;
8
- }
9
- }
1
+ import { IRoleDefinitions, ISecurableMethods } from "./types.js";
2
+ declare module "../webs/types" {
3
+ interface _Web extends ISecurableMethods {
4
+ roleDefinitions: IRoleDefinitions;
5
+ }
6
+ interface IWeb extends ISecurableMethods {
7
+ roleDefinitions: IRoleDefinitions;
8
+ }
9
+ }
10
10
  //# sourceMappingURL=web.d.ts.map
package/security/web.js CHANGED
@@ -1,16 +1,16 @@
1
- import { addProp } from "@pnp/odata";
2
- import { _Web } from "../webs/types.js";
3
- import { RoleDefinitions, RoleAssignments } from "./types.js";
4
- import { SharePointQueryableInstance } from "../sharepointqueryable.js";
5
- import { getUserEffectivePermissions, getCurrentUserEffectivePermissions, breakRoleInheritance, resetRoleInheritance, userHasPermissions, currentUserHasPermissions, hasPermissions, } from "./funcs.js";
6
- addProp(_Web, "roleDefinitions", RoleDefinitions);
7
- addProp(_Web, "roleAssignments", RoleAssignments);
8
- addProp(_Web, "firstUniqueAncestorSecurableObject", SharePointQueryableInstance);
9
- _Web.prototype.getUserEffectivePermissions = getUserEffectivePermissions;
10
- _Web.prototype.getCurrentUserEffectivePermissions = getCurrentUserEffectivePermissions;
11
- _Web.prototype.breakRoleInheritance = breakRoleInheritance;
12
- _Web.prototype.resetRoleInheritance = resetRoleInheritance;
13
- _Web.prototype.userHasPermissions = userHasPermissions;
14
- _Web.prototype.currentUserHasPermissions = currentUserHasPermissions;
15
- _Web.prototype.hasPermissions = hasPermissions;
1
+ import { addProp } from "@pnp/odata";
2
+ import { _Web } from "../webs/types.js";
3
+ import { RoleDefinitions, RoleAssignments } from "./types.js";
4
+ import { SharePointQueryableInstance } from "../sharepointqueryable.js";
5
+ import { getUserEffectivePermissions, getCurrentUserEffectivePermissions, breakRoleInheritance, resetRoleInheritance, userHasPermissions, currentUserHasPermissions, hasPermissions, } from "./funcs.js";
6
+ addProp(_Web, "roleDefinitions", RoleDefinitions);
7
+ addProp(_Web, "roleAssignments", RoleAssignments);
8
+ addProp(_Web, "firstUniqueAncestorSecurableObject", SharePointQueryableInstance);
9
+ _Web.prototype.getUserEffectivePermissions = getUserEffectivePermissions;
10
+ _Web.prototype.getCurrentUserEffectivePermissions = getCurrentUserEffectivePermissions;
11
+ _Web.prototype.breakRoleInheritance = breakRoleInheritance;
12
+ _Web.prototype.resetRoleInheritance = resetRoleInheritance;
13
+ _Web.prototype.userHasPermissions = userHasPermissions;
14
+ _Web.prototype.currentUserHasPermissions = currentUserHasPermissions;
15
+ _Web.prototype.hasPermissions = hasPermissions;
16
16
  //# sourceMappingURL=web.js.map
@@ -1,136 +1,136 @@
1
- import { IFetchOptions } from "@pnp/common";
2
- import { Queryable, IInvokable, IRequestContext } from "@pnp/odata";
3
- import { SPBatch } from "./batch.js";
4
- export interface ISharePointQueryableConstructor<T extends ISharePointQueryable = ISharePointQueryable> {
5
- new (baseUrl: string | ISharePointQueryable, path?: string): T;
6
- }
7
- export declare type ISPInvokableFactory<R extends any> = (baseUrl: string | ISharePointQueryable, path?: string) => R & IInvokable;
8
- export declare const spInvokableFactory: <R>(f: any) => ISPInvokableFactory<R>;
9
- /**
10
- * SharePointQueryable Base Class
11
- *
12
- */
13
- export declare class _SharePointQueryable<GetType = any> extends Queryable<GetType> {
14
- protected _forceCaching: boolean;
15
- /**
16
- * Creates a new instance of the SharePointQueryable class
17
- *
18
- * @constructor
19
- * @param baseUrl A string or SharePointQueryable that should form the base part of the url
20
- *
21
- */
22
- constructor(baseUrl: string | ISharePointQueryable, path?: string);
23
- /**
24
- * Gets the full url with query information
25
- */
26
- toUrlAndQuery(): string;
27
- /**
28
- * Choose which fields to return
29
- *
30
- * @param selects One or more fields to return
31
- */
32
- select(...selects: string[]): this;
33
- get<T = GetType>(options?: IFetchOptions): Promise<T>;
34
- /**
35
- * Expands fields such as lookups to get additional data
36
- *
37
- * @param expands The Fields for which to expand the values
38
- */
39
- expand(...expands: string[]): this;
40
- /**
41
- * Clones this SharePointQueryable into a new SharePointQueryable instance of T
42
- * @param factory Constructor used to create the new instance
43
- * @param additionalPath Any additional path to include in the clone
44
- * @param includeBatch If true this instance's batch will be added to the cloned instance
45
- * @param includeQuery If true all of the query values will be copied to the cloned instance
46
- */
47
- clone<T extends ISharePointQueryable>(factory: (...args: any[]) => T, additionalPath?: string, includeBatch?: boolean, includeQuery?: boolean): T;
48
- /**
49
- * The default action for this object (unless overridden spGet)
50
- *
51
- * @param options optional request options
52
- */
53
- defaultAction(options?: IFetchOptions): Promise<GetType>;
54
- /**
55
- * Gets a parent for this instance as specified
56
- *
57
- * @param factory The contructor for the class to create
58
- */
59
- protected getParent<T extends ISharePointQueryable>(factory: ISPInvokableFactory<any>, baseUrl?: string | ISharePointQueryable, path?: string, batch?: SPBatch): T;
60
- }
61
- export interface ISharePointQueryable<GetType = any> extends _SharePointQueryable<GetType> {
62
- }
63
- export interface _SharePointQueryable<GetType = any> {
64
- <T = GetType>(options?: Partial<IRequestContext<T>>): Promise<T>;
65
- }
66
- export declare const SharePointQueryable: ISPInvokableFactory<ISharePointQueryable<any>>;
67
- /**
68
- * Represents a REST collection which can be filtered, paged, and selected
69
- *
70
- */
71
- export declare class _SharePointQueryableCollection<GetType = any[]> extends _SharePointQueryable<GetType> {
72
- /**
73
- * Filters the returned collection (https://msdn.microsoft.com/en-us/library/office/fp142385.aspx#bk_supported)
74
- *
75
- * @param filter The string representing the filter query
76
- */
77
- filter(filter: string): this;
78
- /**
79
- * Orders based on the supplied fields
80
- *
81
- * @param orderby The name of the field on which to sort
82
- * @param ascending If false DESC is appended, otherwise ASC (default)
83
- */
84
- orderBy(orderBy: string, ascending?: boolean): this;
85
- /**
86
- * Skips the specified number of items
87
- *
88
- * @param skip The number of items to skip
89
- */
90
- skip(skip: number): this;
91
- /**
92
- * Limits the query to only return the specified number of items
93
- *
94
- * @param top The query row limit
95
- */
96
- top(top: number): this;
97
- }
98
- export interface ISharePointQueryableCollection<GetType = any[]> extends _SharePointQueryableCollection<GetType> {
99
- }
100
- export declare const SharePointQueryableCollection: ISPInvokableFactory<ISharePointQueryableCollection<any[]>>;
101
- /**
102
- * Represents an instance that can be selected
103
- *
104
- */
105
- export declare class _SharePointQueryableInstance<GetType = any> extends _SharePointQueryable<GetType> {
106
- /**
107
- * Curries the update function into the common pieces
108
- *
109
- * @param type
110
- * @param mapper
111
- */
112
- protected _update<Return, Props = any>(type: string, mapper: (data: any, props: Props) => Return): (props: Props) => Promise<Return>;
113
- }
114
- export interface ISharePointQueryableInstance<GetType = any> extends _SharePointQueryableInstance<GetType> {
115
- }
116
- export declare const SharePointQueryableInstance: ISPInvokableFactory<ISharePointQueryableInstance<any>>;
117
- /**
118
- * Adds the a delete method to the tagged class taking no parameters and calling spPostDelete
119
- */
120
- export declare function deleteable(t: string): (this: ISharePointQueryable) => Promise<void>;
121
- export interface IDeleteable {
122
- /**
123
- * Delete this instance
124
- */
125
- delete(): Promise<void>;
126
- }
127
- export declare function deleteableWithETag(t: string): (this: ISharePointQueryable, eTag?: string) => Promise<void>;
128
- export interface IDeleteableWithETag {
129
- /**
130
- * Delete this instance
131
- *
132
- * @param eTag Value used in the IF-Match header, by default "*"
133
- */
134
- delete(eTag?: string): Promise<void>;
135
- }
1
+ import { IFetchOptions } from "@pnp/common";
2
+ import { Queryable, IInvokable, IRequestContext } from "@pnp/odata";
3
+ import { SPBatch } from "./batch.js";
4
+ export interface ISharePointQueryableConstructor<T extends ISharePointQueryable = ISharePointQueryable> {
5
+ new (baseUrl: string | ISharePointQueryable, path?: string): T;
6
+ }
7
+ export declare type ISPInvokableFactory<R extends any> = (baseUrl: string | ISharePointQueryable, path?: string) => R & IInvokable;
8
+ export declare const spInvokableFactory: <R>(f: any) => ISPInvokableFactory<R>;
9
+ /**
10
+ * SharePointQueryable Base Class
11
+ *
12
+ */
13
+ export declare class _SharePointQueryable<GetType = any> extends Queryable<GetType> {
14
+ protected _forceCaching: boolean;
15
+ /**
16
+ * Creates a new instance of the SharePointQueryable class
17
+ *
18
+ * @constructor
19
+ * @param baseUrl A string or SharePointQueryable that should form the base part of the url
20
+ *
21
+ */
22
+ constructor(baseUrl: string | ISharePointQueryable, path?: string);
23
+ /**
24
+ * Gets the full url with query information
25
+ */
26
+ toUrlAndQuery(): string;
27
+ /**
28
+ * Choose which fields to return
29
+ *
30
+ * @param selects One or more fields to return
31
+ */
32
+ select(...selects: string[]): this;
33
+ get<T = GetType>(options?: IFetchOptions): Promise<T>;
34
+ /**
35
+ * Expands fields such as lookups to get additional data
36
+ *
37
+ * @param expands The Fields for which to expand the values
38
+ */
39
+ expand(...expands: string[]): this;
40
+ /**
41
+ * Clones this SharePointQueryable into a new SharePointQueryable instance of T
42
+ * @param factory Constructor used to create the new instance
43
+ * @param additionalPath Any additional path to include in the clone
44
+ * @param includeBatch If true this instance's batch will be added to the cloned instance
45
+ * @param includeQuery If true all of the query values will be copied to the cloned instance
46
+ */
47
+ clone<T extends ISharePointQueryable>(factory: (...args: any[]) => T, additionalPath?: string, includeBatch?: boolean, includeQuery?: boolean): T;
48
+ /**
49
+ * The default action for this object (unless overridden spGet)
50
+ *
51
+ * @param options optional request options
52
+ */
53
+ defaultAction(options?: IFetchOptions): Promise<GetType>;
54
+ /**
55
+ * Gets a parent for this instance as specified
56
+ *
57
+ * @param factory The contructor for the class to create
58
+ */
59
+ protected getParent<T extends ISharePointQueryable>(factory: ISPInvokableFactory<any>, baseUrl?: string | ISharePointQueryable, path?: string, batch?: SPBatch): T;
60
+ }
61
+ export interface ISharePointQueryable<GetType = any> extends _SharePointQueryable<GetType> {
62
+ }
63
+ export interface _SharePointQueryable<GetType = any> {
64
+ <T = GetType>(options?: Partial<IRequestContext<T>>): Promise<T>;
65
+ }
66
+ export declare const SharePointQueryable: ISPInvokableFactory<ISharePointQueryable<any>>;
67
+ /**
68
+ * Represents a REST collection which can be filtered, paged, and selected
69
+ *
70
+ */
71
+ export declare class _SharePointQueryableCollection<GetType = any[]> extends _SharePointQueryable<GetType> {
72
+ /**
73
+ * Filters the returned collection (https://msdn.microsoft.com/en-us/library/office/fp142385.aspx#bk_supported)
74
+ *
75
+ * @param filter The string representing the filter query
76
+ */
77
+ filter(filter: string): this;
78
+ /**
79
+ * Orders based on the supplied fields
80
+ *
81
+ * @param orderby The name of the field on which to sort
82
+ * @param ascending If false DESC is appended, otherwise ASC (default)
83
+ */
84
+ orderBy(orderBy: string, ascending?: boolean): this;
85
+ /**
86
+ * Skips the specified number of items
87
+ *
88
+ * @param skip The number of items to skip
89
+ */
90
+ skip(skip: number): this;
91
+ /**
92
+ * Limits the query to only return the specified number of items
93
+ *
94
+ * @param top The query row limit
95
+ */
96
+ top(top: number): this;
97
+ }
98
+ export interface ISharePointQueryableCollection<GetType = any[]> extends _SharePointQueryableCollection<GetType> {
99
+ }
100
+ export declare const SharePointQueryableCollection: ISPInvokableFactory<ISharePointQueryableCollection<any[]>>;
101
+ /**
102
+ * Represents an instance that can be selected
103
+ *
104
+ */
105
+ export declare class _SharePointQueryableInstance<GetType = any> extends _SharePointQueryable<GetType> {
106
+ /**
107
+ * Curries the update function into the common pieces
108
+ *
109
+ * @param type
110
+ * @param mapper
111
+ */
112
+ protected _update<Return, Props = any>(type: string, mapper: (data: any, props: Props) => Return): (props: Props) => Promise<Return>;
113
+ }
114
+ export interface ISharePointQueryableInstance<GetType = any> extends _SharePointQueryableInstance<GetType> {
115
+ }
116
+ export declare const SharePointQueryableInstance: ISPInvokableFactory<ISharePointQueryableInstance<any>>;
117
+ /**
118
+ * Adds the a delete method to the tagged class taking no parameters and calling spPostDelete
119
+ */
120
+ export declare function deleteable(t: string): (this: ISharePointQueryable) => Promise<void>;
121
+ export interface IDeleteable {
122
+ /**
123
+ * Delete this instance
124
+ */
125
+ delete(): Promise<void>;
126
+ }
127
+ export declare function deleteableWithETag(t: string): (this: ISharePointQueryable, eTag?: string) => Promise<void>;
128
+ export interface IDeleteableWithETag {
129
+ /**
130
+ * Delete this instance
131
+ *
132
+ * @param eTag Value used in the IF-Match header, by default "*"
133
+ */
134
+ delete(eTag?: string): Promise<void>;
135
+ }
136
136
  //# sourceMappingURL=sharepointqueryable.d.ts.map