@pnp/sp 2.8.0 → 2.12.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 (306) 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.d.ts.map +1 -1
  6. package/appcatalog/types.js +177 -177
  7. package/appcatalog/types.js.map +1 -1
  8. package/appcatalog/web.d.ts +16 -16
  9. package/appcatalog/web.js +6 -6
  10. package/attachments/index.d.ts +2 -2
  11. package/attachments/index.js +2 -2
  12. package/attachments/item.d.ts +12 -12
  13. package/attachments/item.js +4 -4
  14. package/attachments/types.d.ts +92 -92
  15. package/attachments/types.js +240 -240
  16. package/batch.d.ts +17 -17
  17. package/batch.js +223 -223
  18. package/clientside-pages/funcs.d.ts +22 -22
  19. package/clientside-pages/funcs.js +25 -25
  20. package/clientside-pages/index.d.ts +2 -2
  21. package/clientside-pages/index.js +2 -2
  22. package/clientside-pages/types.d.ts +496 -494
  23. package/clientside-pages/types.d.ts.map +1 -1
  24. package/clientside-pages/types.js +1496 -1487
  25. package/clientside-pages/types.js.map +1 -1
  26. package/clientside-pages/web.d.ts +41 -41
  27. package/clientside-pages/web.js +57 -57
  28. package/column-defaults/folder.d.ts +27 -27
  29. package/column-defaults/folder.js +82 -82
  30. package/column-defaults/index.d.ts +3 -3
  31. package/column-defaults/index.js +2 -2
  32. package/column-defaults/list.d.ts +19 -19
  33. package/column-defaults/list.js +198 -198
  34. package/column-defaults/types.d.ts +21 -21
  35. package/column-defaults/types.js +1 -1
  36. package/comments/clientside-page.d.ts +57 -57
  37. package/comments/clientside-page.d.ts.map +1 -1
  38. package/comments/clientside-page.js +136 -136
  39. package/comments/index.d.ts +2 -2
  40. package/comments/index.js +2 -2
  41. package/comments/item.d.ts +29 -29
  42. package/comments/item.js +47 -47
  43. package/comments/item.js.map +1 -1
  44. package/comments/types.d.ts +107 -107
  45. package/comments/types.d.ts.map +1 -1
  46. package/comments/types.js +145 -145
  47. package/comments/types.js.map +1 -1
  48. package/content-types/index.d.ts +4 -4
  49. package/content-types/index.js +4 -4
  50. package/content-types/item.d.ts +12 -12
  51. package/content-types/item.js +4 -4
  52. package/content-types/list.d.ts +12 -12
  53. package/content-types/list.js +4 -4
  54. package/content-types/types.d.ts +107 -107
  55. package/content-types/types.js +166 -166
  56. package/content-types/web.d.ts +12 -12
  57. package/content-types/web.js +4 -4
  58. package/decorators.d.ts +11 -11
  59. package/decorators.js +28 -28
  60. package/features/index.d.ts +3 -3
  61. package/features/index.js +3 -3
  62. package/features/site.d.ts +12 -12
  63. package/features/site.js +4 -4
  64. package/features/types.d.ts +47 -47
  65. package/features/types.js +109 -109
  66. package/features/web.d.ts +12 -12
  67. package/features/web.js +4 -4
  68. package/fields/index.d.ts +4 -4
  69. package/fields/index.js +4 -4
  70. package/fields/list.d.ts +12 -12
  71. package/fields/list.js +4 -4
  72. package/fields/types.d.ts +368 -368
  73. package/fields/types.js +624 -624
  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.d.ts.map +1 -1
  110. package/hubsites/types.js +53 -53
  111. package/hubsites/web.d.ts +21 -21
  112. package/hubsites/web.js +23 -23
  113. package/index.d.ts +14 -14
  114. package/index.js +13 -13
  115. package/items/index.d.ts +2 -2
  116. package/items/index.js +2 -2
  117. package/items/list.d.ts +9 -9
  118. package/items/list.js +4 -4
  119. package/items/types.d.ts +226 -226
  120. package/items/types.js +549 -549
  121. package/lists/index.d.ts +2 -2
  122. package/lists/index.js +2 -2
  123. package/lists/types.d.ts +495 -495
  124. package/lists/types.js +522 -522
  125. package/lists/types.js.map +1 -1
  126. package/lists/web.d.ts +43 -43
  127. package/lists/web.js +27 -27
  128. package/navigation/index.d.ts +8 -8
  129. package/navigation/index.js +14 -14
  130. package/navigation/types.d.ts +154 -154
  131. package/navigation/types.js +219 -219
  132. package/navigation/web.d.ts +13 -13
  133. package/navigation/web.js +4 -4
  134. package/odata.d.ts +5 -5
  135. package/odata.js +90 -90
  136. package/odata.js.map +1 -1
  137. package/operations.d.ts +9 -9
  138. package/operations.js +63 -63
  139. package/package.json +4 -4
  140. package/presets/all.d.ts +72 -72
  141. package/presets/all.js +72 -72
  142. package/presets/core.d.ts +11 -11
  143. package/presets/core.js +11 -11
  144. package/profiles/index.d.ts +7 -7
  145. package/profiles/index.js +13 -13
  146. package/profiles/types.d.ts +357 -357
  147. package/profiles/types.js +454 -454
  148. package/readme.md +21 -21
  149. package/regional-settings/content-type.d.ts +7 -7
  150. package/regional-settings/content-type.js +4 -4
  151. package/regional-settings/field.d.ts +7 -7
  152. package/regional-settings/field.js +4 -4
  153. package/regional-settings/funcs.d.ts +2 -2
  154. package/regional-settings/funcs.js +8 -8
  155. package/regional-settings/index.d.ts +6 -6
  156. package/regional-settings/index.js +6 -6
  157. package/regional-settings/list.d.ts +7 -7
  158. package/regional-settings/list.js +4 -4
  159. package/regional-settings/types.d.ts +111 -111
  160. package/regional-settings/types.js +159 -159
  161. package/regional-settings/user-custom-actions.d.ts +7 -7
  162. package/regional-settings/user-custom-actions.js +4 -4
  163. package/regional-settings/web.d.ts +12 -12
  164. package/regional-settings/web.js +7 -7
  165. package/related-items/index.d.ts +1 -1
  166. package/related-items/index.js +1 -1
  167. package/related-items/types.d.ts +76 -76
  168. package/related-items/types.js +103 -103
  169. package/related-items/web.d.ts +12 -12
  170. package/related-items/web.js +9 -9
  171. package/rest.d.ts +44 -44
  172. package/rest.js +72 -72
  173. package/search/index.d.ts +30 -30
  174. package/search/index.js +25 -25
  175. package/search/query.d.ts +62 -62
  176. package/search/query.js +302 -302
  177. package/search/suggest.d.ts +76 -76
  178. package/search/suggest.js +66 -66
  179. package/search/types.d.ts +426 -426
  180. package/search/types.js +57 -57
  181. package/security/funcs.d.ts +43 -43
  182. package/security/funcs.js +142 -142
  183. package/security/index.d.ts +4 -4
  184. package/security/index.js +4 -4
  185. package/security/item.d.ts +7 -7
  186. package/security/item.js +14 -14
  187. package/security/list.d.ts +7 -7
  188. package/security/list.js +14 -14
  189. package/security/types.d.ts +318 -318
  190. package/security/types.js +399 -399
  191. package/security/web.d.ts +9 -9
  192. package/security/web.js +15 -15
  193. package/sharepointqueryable.d.ts +135 -135
  194. package/sharepointqueryable.js +265 -265
  195. package/sharing/file.d.ts +18 -18
  196. package/sharing/file.js +116 -116
  197. package/sharing/folder.d.ts +9 -9
  198. package/sharing/folder.js +136 -136
  199. package/sharing/funcs.d.ts +62 -62
  200. package/sharing/funcs.js +239 -239
  201. package/sharing/funcs.js.map +1 -1
  202. package/sharing/index.d.ts +5 -5
  203. package/sharing/index.js +5 -5
  204. package/sharing/item.d.ts +16 -16
  205. package/sharing/item.js +15 -15
  206. package/sharing/types.d.ts +583 -583
  207. package/sharing/types.js +113 -113
  208. package/sharing/web.d.ts +19 -19
  209. package/sharing/web.js +76 -76
  210. package/site-designs/index.d.ts +8 -8
  211. package/site-designs/index.js +14 -14
  212. package/site-designs/types.d.ts +319 -319
  213. package/site-designs/types.js +203 -203
  214. package/site-designs/web.d.ts +25 -25
  215. package/site-designs/web.js +11 -11
  216. package/site-groups/index.d.ts +2 -2
  217. package/site-groups/index.js +2 -2
  218. package/site-groups/types.d.ts +89 -89
  219. package/site-groups/types.js +125 -125
  220. package/site-groups/web.d.ts +40 -40
  221. package/site-groups/web.js +30 -30
  222. package/site-scripts/index.d.ts +9 -9
  223. package/site-scripts/index.js +15 -15
  224. package/site-scripts/list.d.ts +12 -12
  225. package/site-scripts/list.js +24 -24
  226. package/site-scripts/types.d.ts +183 -183
  227. package/site-scripts/types.js +141 -141
  228. package/site-scripts/web.d.ts +13 -13
  229. package/site-scripts/web.js +5 -5
  230. package/site-users/index.d.ts +2 -2
  231. package/site-users/index.js +2 -2
  232. package/site-users/types.d.ts +138 -138
  233. package/site-users/types.js +122 -122
  234. package/site-users/web.d.ts +31 -31
  235. package/site-users/web.js +27 -27
  236. package/sites/index.d.ts +7 -7
  237. package/sites/index.js +13 -13
  238. package/sites/types.d.ts +147 -147
  239. package/sites/types.js +321 -321
  240. package/social/index.d.ts +10 -10
  241. package/social/index.js +13 -13
  242. package/social/types.d.ts +309 -309
  243. package/social/types.js +322 -322
  244. package/sphttpclient.d.ts +18 -18
  245. package/sphttpclient.js +189 -189
  246. package/splibconfig.d.ts +22 -22
  247. package/splibconfig.js +13 -13
  248. package/sputilities/index.d.ts +7 -7
  249. package/sputilities/index.js +13 -13
  250. package/sputilities/types.d.ts +130 -130
  251. package/sputilities/types.js +118 -118
  252. package/subscriptions/index.d.ts +2 -2
  253. package/subscriptions/index.js +2 -2
  254. package/subscriptions/list.d.ts +13 -13
  255. package/subscriptions/list.js +4 -4
  256. package/subscriptions/types.d.ts +54 -54
  257. package/subscriptions/types.js +111 -111
  258. package/taxonomy/index.d.ts +7 -7
  259. package/taxonomy/index.js +13 -13
  260. package/taxonomy/types.d.ts +200 -200
  261. package/taxonomy/types.js +347 -347
  262. package/taxonomy/types.js.map +1 -1
  263. package/telemetry.d.ts +12 -12
  264. package/telemetry.js +48 -48
  265. package/types.d.ts +218 -218
  266. package/types.js +79 -79
  267. package/user-custom-actions/index.d.ts +4 -4
  268. package/user-custom-actions/index.js +4 -4
  269. package/user-custom-actions/list.d.ts +12 -12
  270. package/user-custom-actions/list.js +4 -4
  271. package/user-custom-actions/site.d.ts +12 -12
  272. package/user-custom-actions/site.js +4 -4
  273. package/user-custom-actions/types.d.ts +82 -82
  274. package/user-custom-actions/types.js +93 -93
  275. package/user-custom-actions/web.d.ts +15 -15
  276. package/user-custom-actions/web.js +4 -4
  277. package/utils/escapeQueryStrValue.d.ts +1 -1
  278. package/utils/escapeQueryStrValue.js +19 -19
  279. package/utils/extractweburl.d.ts +1 -1
  280. package/utils/extractweburl.js +15 -15
  281. package/utils/file-names.d.ts +17 -17
  282. package/utils/file-names.js +38 -38
  283. package/utils/metadata.d.ts +5 -5
  284. package/utils/metadata.js +5 -5
  285. package/utils/objectToSPKeyValueCollection.d.ts +20 -20
  286. package/utils/objectToSPKeyValueCollection.js +16 -16
  287. package/utils/toResourcePath.d.ts +7 -7
  288. package/utils/toResourcePath.js +6 -6
  289. package/utils/toabsoluteurl.d.ts +7 -7
  290. package/utils/toabsoluteurl.js +61 -61
  291. package/views/index.d.ts +2 -2
  292. package/views/index.js +2 -2
  293. package/views/list.d.ts +23 -23
  294. package/views/list.js +8 -8
  295. package/views/types.d.ts +140 -140
  296. package/views/types.js +184 -184
  297. package/webparts/file.d.ts +15 -15
  298. package/webparts/file.js +6 -6
  299. package/webparts/index.d.ts +2 -2
  300. package/webparts/index.js +2 -2
  301. package/webparts/types.d.ts +83 -83
  302. package/webparts/types.js +117 -117
  303. package/webs/index.d.ts +16 -16
  304. package/webs/index.js +16 -16
  305. package/webs/types.d.ts +210 -210
  306. 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