@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
@@ -1,42 +1,42 @@
1
- import { IClientsidePageComponent, IClientsidePage, ClientsidePageLayoutType, PromotedState, IRepostPage } from "./types.js";
2
- declare module "../webs/types" {
3
- interface _Web {
4
- getClientsideWebParts(): Promise<IClientsidePageComponent[]>;
5
- addClientsidePage(pageName: string, title?: string, libraryTitle?: string, promotedState?: PromotedState): Promise<IClientsidePage>;
6
- loadClientsidePage(path: string): Promise<IClientsidePage>;
7
- addRepostPage(details: IRepostPage): Promise<string>;
8
- addFullPageApp(pageName: string, title: string, componentId: string, promotedState?: PromotedState): Promise<IClientsidePage>;
9
- }
10
- interface IWeb {
11
- /**
12
- * Gets the collection of available client side web parts for this web instance
13
- */
14
- getClientsideWebParts(): Promise<IClientsidePageComponent[]>;
15
- /**
16
- * Creates a new client side page
17
- *
18
- * @param pageName Name of the new page
19
- * @param title Display title of the new page
20
- */
21
- addClientsidePage(pageName: string, title?: string, PageLayoutType?: ClientsidePageLayoutType, promotedState?: PromotedState): Promise<IClientsidePage>;
22
- /**
23
- * Loads a page from the provided server relative path to the file
24
- *
25
- * @param path Server relative path to the file (ex: "/sites/dev/sitepages/page.aspx")
26
- */
27
- loadClientsidePage(path: string): Promise<IClientsidePage>;
28
- /**
29
- * Adds a repost page
30
- *
31
- * @param details The request details to create the page
32
- */
33
- addRepostPage(details: IRepostPage): Promise<string>;
34
- /**
35
- * Creates a new single page app page and installs the indicated component
36
- *
37
- * @param componentId
38
- */
39
- addFullPageApp(pageName: string, title: string, componentId: string, promotedState?: PromotedState): Promise<IClientsidePage>;
40
- }
41
- }
1
+ import { IClientsidePageComponent, IClientsidePage, ClientsidePageLayoutType, PromotedState, IRepostPage } from "./types.js";
2
+ declare module "../webs/types" {
3
+ interface _Web {
4
+ getClientsideWebParts(): Promise<IClientsidePageComponent[]>;
5
+ addClientsidePage(pageName: string, title?: string, libraryTitle?: string, promotedState?: PromotedState): Promise<IClientsidePage>;
6
+ loadClientsidePage(path: string): Promise<IClientsidePage>;
7
+ addRepostPage(details: IRepostPage): Promise<string>;
8
+ addFullPageApp(pageName: string, title: string, componentId: string, promotedState?: PromotedState): Promise<IClientsidePage>;
9
+ }
10
+ interface IWeb {
11
+ /**
12
+ * Gets the collection of available client side web parts for this web instance
13
+ */
14
+ getClientsideWebParts(): Promise<IClientsidePageComponent[]>;
15
+ /**
16
+ * Creates a new client side page
17
+ *
18
+ * @param pageName Name of the new page
19
+ * @param title Display title of the new page
20
+ */
21
+ addClientsidePage(pageName: string, title?: string, PageLayoutType?: ClientsidePageLayoutType, promotedState?: PromotedState): Promise<IClientsidePage>;
22
+ /**
23
+ * Loads a page from the provided server relative path to the file
24
+ *
25
+ * @param path Server relative path to the file (ex: "/sites/dev/sitepages/page.aspx")
26
+ */
27
+ loadClientsidePage(path: string): Promise<IClientsidePage>;
28
+ /**
29
+ * Adds a repost page
30
+ *
31
+ * @param details The request details to create the page
32
+ */
33
+ addRepostPage(details: IRepostPage): Promise<string>;
34
+ /**
35
+ * Creates a new single page app page and installs the indicated component
36
+ *
37
+ * @param componentId
38
+ */
39
+ addFullPageApp(pageName: string, title: string, componentId: string, promotedState?: PromotedState): Promise<IClientsidePage>;
40
+ }
41
+ }
42
42
  //# sourceMappingURL=web.d.ts.map
@@ -1,58 +1,58 @@
1
- import { __awaiter, __generator } from "tslib";
2
- import { _Web } from "../webs/types.js";
3
- import { CreateClientsidePage, ClientsidePageFromFile, ClientsideWebpart, } from "./types.js";
4
- import { SharePointQueryableInstance, SharePointQueryableCollection } from "../sharepointqueryable.js";
5
- import { extractWebUrl } from "../utils/extractweburl.js";
6
- import { spPost } from "../operations.js";
7
- import { body } from "@pnp/odata";
8
- import { metadata } from "../utils/metadata.js";
9
- import { assign } from "@pnp/common";
10
- _Web.prototype.getClientsideWebParts = function () {
11
- return this.clone(SharePointQueryableCollection, "GetClientSideWebParts")();
12
- };
13
- _Web.prototype.addClientsidePage =
14
- function (pageName, title, layout, promotedState) {
15
- if (title === void 0) { title = pageName.replace(/\.[^/.]+$/, ""); }
16
- return CreateClientsidePage(this, pageName, title, layout, promotedState);
17
- };
18
- _Web.prototype.loadClientsidePage = function (path) {
19
- return ClientsidePageFromFile(this.getFileByServerRelativePath(path));
20
- };
21
- _Web.prototype.addRepostPage = function (details) {
22
- return __awaiter(this, void 0, void 0, function () {
23
- var query, r;
24
- return __generator(this, function (_a) {
25
- switch (_a.label) {
26
- case 0:
27
- query = SharePointQueryableInstance(extractWebUrl(this.toUrl()), "_api/sitepages/pages/reposts").configureFrom(this);
28
- return [4 /*yield*/, spPost(query, body(assign(metadata("SP.Publishing.RepostPage"), details)))];
29
- case 1:
30
- r = _a.sent();
31
- return [2 /*return*/, r.AbsoluteUrl];
32
- }
33
- });
34
- });
35
- };
36
- // eslint-disable-next-line max-len
37
- _Web.prototype.addFullPageApp = function (pageName, title, componentId, promotedState) {
38
- if (title === void 0) { title = pageName.replace(/\.[^/.]+$/, ""); }
39
- return __awaiter(this, void 0, void 0, function () {
40
- var parts, test, partDef, part, page;
41
- return __generator(this, function (_a) {
42
- switch (_a.label) {
43
- case 0: return [4 /*yield*/, this.getClientsideWebParts()];
44
- case 1:
45
- parts = _a.sent();
46
- test = new RegExp("{?" + componentId + "}?", "i");
47
- partDef = parts.find(function (p) { return test.test(p.Id); });
48
- part = ClientsideWebpart.fromComponentDef(partDef);
49
- return [4 /*yield*/, this.addClientsidePage(pageName, title, "SingleWebPartAppPage", promotedState)];
50
- case 2:
51
- page = _a.sent();
52
- page.addSection().addColumn(12).addControl(part);
53
- return [2 /*return*/, page];
54
- }
55
- });
56
- });
57
- };
1
+ import { __awaiter, __generator } from "tslib";
2
+ import { _Web } from "../webs/types.js";
3
+ import { CreateClientsidePage, ClientsidePageFromFile, ClientsideWebpart, } from "./types.js";
4
+ import { SharePointQueryableInstance, SharePointQueryableCollection } from "../sharepointqueryable.js";
5
+ import { extractWebUrl } from "../utils/extractweburl.js";
6
+ import { spPost } from "../operations.js";
7
+ import { body } from "@pnp/odata";
8
+ import { metadata } from "../utils/metadata.js";
9
+ import { assign } from "@pnp/common";
10
+ _Web.prototype.getClientsideWebParts = function () {
11
+ return this.clone(SharePointQueryableCollection, "GetClientSideWebParts")();
12
+ };
13
+ _Web.prototype.addClientsidePage =
14
+ function (pageName, title, layout, promotedState) {
15
+ if (title === void 0) { title = pageName.replace(/\.[^/.]+$/, ""); }
16
+ return CreateClientsidePage(this, pageName, title, layout, promotedState);
17
+ };
18
+ _Web.prototype.loadClientsidePage = function (path) {
19
+ return ClientsidePageFromFile(this.getFileByServerRelativePath(path));
20
+ };
21
+ _Web.prototype.addRepostPage = function (details) {
22
+ return __awaiter(this, void 0, void 0, function () {
23
+ var query, r;
24
+ return __generator(this, function (_a) {
25
+ switch (_a.label) {
26
+ case 0:
27
+ query = SharePointQueryableInstance(extractWebUrl(this.toUrl()), "_api/sitepages/pages/reposts").configureFrom(this);
28
+ return [4 /*yield*/, spPost(query, body(assign(metadata("SP.Publishing.RepostPage"), details)))];
29
+ case 1:
30
+ r = _a.sent();
31
+ return [2 /*return*/, r.AbsoluteUrl];
32
+ }
33
+ });
34
+ });
35
+ };
36
+ // eslint-disable-next-line max-len
37
+ _Web.prototype.addFullPageApp = function (pageName, title, componentId, promotedState) {
38
+ if (title === void 0) { title = pageName.replace(/\.[^/.]+$/, ""); }
39
+ return __awaiter(this, void 0, void 0, function () {
40
+ var parts, test, partDef, part, page;
41
+ return __generator(this, function (_a) {
42
+ switch (_a.label) {
43
+ case 0: return [4 /*yield*/, this.getClientsideWebParts()];
44
+ case 1:
45
+ parts = _a.sent();
46
+ test = new RegExp("{?" + componentId + "}?", "i");
47
+ partDef = parts.find(function (p) { return test.test(p.Id); });
48
+ part = ClientsideWebpart.fromComponentDef(partDef);
49
+ return [4 /*yield*/, this.addClientsidePage(pageName, title, "SingleWebPartAppPage", promotedState)];
50
+ case 2:
51
+ page = _a.sent();
52
+ page.addSection().addColumn(12).addControl(part);
53
+ return [2 /*return*/, page];
54
+ }
55
+ });
56
+ });
57
+ };
58
58
  //# sourceMappingURL=web.js.map
@@ -1,28 +1,28 @@
1
- import "../lists/web.js";
2
- import { IFieldDefault, IFieldDefaultProps } from "./types.js";
3
- declare module "../folders/types" {
4
- interface _Folder {
5
- getDefaultColumnValues(): Promise<IFieldDefault[]>;
6
- setDefaultColumnValues(defaults: IFieldDefaultProps[], merge?: boolean): Promise<void>;
7
- clearDefaultColumnValues(): Promise<void>;
8
- }
9
- interface IFolder {
10
- /**
11
- * Gets the default column value for a given list
12
- */
13
- getDefaultColumnValues(): Promise<IFieldDefault[]>;
14
- /**
15
- *
16
- * Sets the default column values for this folder
17
- *
18
- * @param fieldDefaults The values to set including field name and appropriate value
19
- * @param merge If true (default) existing values will be updated and new values added, otherwise all defaults are replaced for this folder
20
- */
21
- setDefaultColumnValues(defaults: IFieldDefaultProps[], merge?: boolean): Promise<void>;
22
- /**
23
- * Clears all defaults from this folder
24
- */
25
- clearDefaultColumnValues(): Promise<void>;
26
- }
27
- }
1
+ import "../lists/web.js";
2
+ import { IFieldDefault, IFieldDefaultProps } from "./types.js";
3
+ declare module "../folders/types" {
4
+ interface _Folder {
5
+ getDefaultColumnValues(): Promise<IFieldDefault[]>;
6
+ setDefaultColumnValues(defaults: IFieldDefaultProps[], merge?: boolean): Promise<void>;
7
+ clearDefaultColumnValues(): Promise<void>;
8
+ }
9
+ interface IFolder {
10
+ /**
11
+ * Gets the default column value for a given list
12
+ */
13
+ getDefaultColumnValues(): Promise<IFieldDefault[]>;
14
+ /**
15
+ *
16
+ * Sets the default column values for this folder
17
+ *
18
+ * @param fieldDefaults The values to set including field name and appropriate value
19
+ * @param merge If true (default) existing values will be updated and new values added, otherwise all defaults are replaced for this folder
20
+ */
21
+ setDefaultColumnValues(defaults: IFieldDefaultProps[], merge?: boolean): Promise<void>;
22
+ /**
23
+ * Clears all defaults from this folder
24
+ */
25
+ clearDefaultColumnValues(): Promise<void>;
26
+ }
27
+ }
28
28
  //# sourceMappingURL=folder.d.ts.map
@@ -1,83 +1,83 @@
1
- import { __awaiter, __generator } from "tslib";
2
- import { odataUrlFrom } from "../odata.js";
3
- import { extractWebUrl } from "../utils/extractweburl.js";
4
- import { Web } from "../webs/types.js";
5
- import "../lists/web.js";
6
- import { _Folder, Folder } from "../folders/types.js";
7
- _Folder.prototype.getDefaultColumnValues = function () {
8
- return __awaiter(this, void 0, void 0, function () {
9
- var folderProps, serRelPath, web, docLib;
10
- return __generator(this, function (_a) {
11
- switch (_a.label) {
12
- case 0: return [4 /*yield*/, Folder(this, "Properties").select("vti_x005f_listname")()];
13
- case 1:
14
- folderProps = _a.sent();
15
- return [4 /*yield*/, this.select("ServerRelativePath")()];
16
- case 2:
17
- serRelPath = (_a.sent()).ServerRelativePath;
18
- web = Web(extractWebUrl(odataUrlFrom(folderProps))).configureFrom(this);
19
- docLib = web.lists.getById(folderProps.vti_x005f_listname);
20
- return [4 /*yield*/, docLib.getDefaultColumnValues()];
21
- case 3:
22
- // and we return the defaults associated with this folder's server relative path only
23
- // if you want all the defaults use list.getDefaultColumnValues()
24
- return [2 /*return*/, (_a.sent()).filter(function (v) { return v.path.toLowerCase() === serRelPath.DecodedUrl.toLowerCase(); })];
25
- }
26
- });
27
- });
28
- };
29
- _Folder.prototype.setDefaultColumnValues = function (fieldDefaults, merge) {
30
- if (merge === void 0) { merge = true; }
31
- return __awaiter(this, void 0, void 0, function () {
32
- var folderProps, web, docLib, folderPath, existingDefaults, filteredExistingDefaults;
33
- return __generator(this, function (_a) {
34
- switch (_a.label) {
35
- case 0: return [4 /*yield*/, Folder(this, "Properties").select("vti_x005f_listname")()];
36
- case 1:
37
- folderProps = _a.sent();
38
- web = Web(extractWebUrl(odataUrlFrom(folderProps))).configureFrom(this);
39
- docLib = web.lists.getById(folderProps.vti_x005f_listname);
40
- return [4 /*yield*/, this.select("ServerRelativePath")()];
41
- case 2:
42
- folderPath = (_a.sent()).ServerRelativePath.DecodedUrl;
43
- return [4 /*yield*/, docLib.getDefaultColumnValues()];
44
- case 3:
45
- existingDefaults = _a.sent();
46
- filteredExistingDefaults = merge ? existingDefaults : existingDefaults.filter(function (f) { return f.path !== folderPath; });
47
- // we update / add any new defaults from those passed to this method
48
- fieldDefaults.forEach(function (d) {
49
- var existing = filteredExistingDefaults.find(function (ed) { return ed.name === d.name && ed.path === folderPath; });
50
- if (existing) {
51
- existing.value = d.value;
52
- }
53
- else {
54
- filteredExistingDefaults.push({
55
- name: d.name,
56
- path: folderPath,
57
- value: d.value,
58
- });
59
- }
60
- });
61
- // after this operation filteredExistingDefaults should contain all the value we want to write to the file
62
- return [4 /*yield*/, docLib.setDefaultColumnValues(filteredExistingDefaults)];
63
- case 4:
64
- // after this operation filteredExistingDefaults should contain all the value we want to write to the file
65
- _a.sent();
66
- return [2 /*return*/];
67
- }
68
- });
69
- });
70
- };
71
- _Folder.prototype.clearDefaultColumnValues = function () {
72
- return __awaiter(this, void 0, void 0, function () {
73
- return __generator(this, function (_a) {
74
- switch (_a.label) {
75
- case 0: return [4 /*yield*/, this.setDefaultColumnValues([], false)];
76
- case 1:
77
- _a.sent();
78
- return [2 /*return*/];
79
- }
80
- });
81
- });
82
- };
1
+ import { __awaiter, __generator } from "tslib";
2
+ import { odataUrlFrom } from "../odata.js";
3
+ import { extractWebUrl } from "../utils/extractweburl.js";
4
+ import { Web } from "../webs/types.js";
5
+ import "../lists/web.js";
6
+ import { _Folder, Folder } from "../folders/types.js";
7
+ _Folder.prototype.getDefaultColumnValues = function () {
8
+ return __awaiter(this, void 0, void 0, function () {
9
+ var folderProps, serRelPath, web, docLib;
10
+ return __generator(this, function (_a) {
11
+ switch (_a.label) {
12
+ case 0: return [4 /*yield*/, Folder(this, "Properties").select("vti_x005f_listname")()];
13
+ case 1:
14
+ folderProps = _a.sent();
15
+ return [4 /*yield*/, this.select("ServerRelativePath")()];
16
+ case 2:
17
+ serRelPath = (_a.sent()).ServerRelativePath;
18
+ web = Web(extractWebUrl(odataUrlFrom(folderProps))).configureFrom(this);
19
+ docLib = web.lists.getById(folderProps.vti_x005f_listname);
20
+ return [4 /*yield*/, docLib.getDefaultColumnValues()];
21
+ case 3:
22
+ // and we return the defaults associated with this folder's server relative path only
23
+ // if you want all the defaults use list.getDefaultColumnValues()
24
+ return [2 /*return*/, (_a.sent()).filter(function (v) { return v.path.toLowerCase() === serRelPath.DecodedUrl.toLowerCase(); })];
25
+ }
26
+ });
27
+ });
28
+ };
29
+ _Folder.prototype.setDefaultColumnValues = function (fieldDefaults, merge) {
30
+ if (merge === void 0) { merge = true; }
31
+ return __awaiter(this, void 0, void 0, function () {
32
+ var folderProps, web, docLib, folderPath, existingDefaults, filteredExistingDefaults;
33
+ return __generator(this, function (_a) {
34
+ switch (_a.label) {
35
+ case 0: return [4 /*yield*/, Folder(this, "Properties").select("vti_x005f_listname")()];
36
+ case 1:
37
+ folderProps = _a.sent();
38
+ web = Web(extractWebUrl(odataUrlFrom(folderProps))).configureFrom(this);
39
+ docLib = web.lists.getById(folderProps.vti_x005f_listname);
40
+ return [4 /*yield*/, this.select("ServerRelativePath")()];
41
+ case 2:
42
+ folderPath = (_a.sent()).ServerRelativePath.DecodedUrl;
43
+ return [4 /*yield*/, docLib.getDefaultColumnValues()];
44
+ case 3:
45
+ existingDefaults = _a.sent();
46
+ filteredExistingDefaults = merge ? existingDefaults : existingDefaults.filter(function (f) { return f.path !== folderPath; });
47
+ // we update / add any new defaults from those passed to this method
48
+ fieldDefaults.forEach(function (d) {
49
+ var existing = filteredExistingDefaults.find(function (ed) { return ed.name === d.name && ed.path === folderPath; });
50
+ if (existing) {
51
+ existing.value = d.value;
52
+ }
53
+ else {
54
+ filteredExistingDefaults.push({
55
+ name: d.name,
56
+ path: folderPath,
57
+ value: d.value,
58
+ });
59
+ }
60
+ });
61
+ // after this operation filteredExistingDefaults should contain all the value we want to write to the file
62
+ return [4 /*yield*/, docLib.setDefaultColumnValues(filteredExistingDefaults)];
63
+ case 4:
64
+ // after this operation filteredExistingDefaults should contain all the value we want to write to the file
65
+ _a.sent();
66
+ return [2 /*return*/];
67
+ }
68
+ });
69
+ });
70
+ };
71
+ _Folder.prototype.clearDefaultColumnValues = function () {
72
+ return __awaiter(this, void 0, void 0, function () {
73
+ return __generator(this, function (_a) {
74
+ switch (_a.label) {
75
+ case 0: return [4 /*yield*/, this.setDefaultColumnValues([], false)];
76
+ case 1:
77
+ _a.sent();
78
+ return [2 /*return*/];
79
+ }
80
+ });
81
+ });
82
+ };
83
83
  //# sourceMappingURL=folder.js.map
@@ -1,4 +1,4 @@
1
- import "./list.js";
2
- import "./folder.js";
3
- export { IFieldDefault, IFieldDefaultProps, AllowedDefaultColumnValues, } from "./types.js";
1
+ import "./list.js";
2
+ import "./folder.js";
3
+ export { IFieldDefault, IFieldDefaultProps, AllowedDefaultColumnValues, } from "./types.js";
4
4
  //# sourceMappingURL=index.d.ts.map
@@ -1,3 +1,3 @@
1
- import "./list.js";
2
- import "./folder.js";
1
+ import "./list.js";
2
+ import "./folder.js";
3
3
  //# sourceMappingURL=index.js.map
@@ -1,20 +1,20 @@
1
- import { IFieldDefault } from "./types.js";
2
- declare module "../lists/types" {
3
- interface _List {
4
- getDefaultColumnValues(): Promise<IFieldDefault[]>;
5
- setDefaultColumnValues(defaults: IFieldDefault[]): Promise<void>;
6
- }
7
- interface IList {
8
- /**
9
- * Gets the default column value for a given list
10
- */
11
- getDefaultColumnValues(): Promise<IFieldDefault[]>;
12
- /**
13
- * Replaces all the column defaults with the supplied values
14
- *
15
- * @param defaults
16
- */
17
- setDefaultColumnValues(defaults: IFieldDefault[]): Promise<void>;
18
- }
19
- }
1
+ import { IFieldDefault } from "./types.js";
2
+ declare module "../lists/types" {
3
+ interface _List {
4
+ getDefaultColumnValues(): Promise<IFieldDefault[]>;
5
+ setDefaultColumnValues(defaults: IFieldDefault[]): Promise<void>;
6
+ }
7
+ interface IList {
8
+ /**
9
+ * Gets the default column value for a given list
10
+ */
11
+ getDefaultColumnValues(): Promise<IFieldDefault[]>;
12
+ /**
13
+ * Replaces all the column defaults with the supplied values
14
+ *
15
+ * @param defaults
16
+ */
17
+ setDefaultColumnValues(defaults: IFieldDefault[]): Promise<void>;
18
+ }
19
+ }
20
20
  //# sourceMappingURL=list.d.ts.map