@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
@@ -1,108 +1,108 @@
1
- import { ITypedHash } from "@pnp/common";
2
- import { _SharePointQueryableInstance, ISharePointQueryableCollection, _SharePointQueryableCollection, IDeleteable } from "../sharepointqueryable.js";
3
- export declare class _ContentTypes extends _SharePointQueryableCollection<IContentTypeInfo[]> {
4
- /**
5
- * Adds an existing contenttype to a content type collection
6
- *
7
- * @param contentTypeId in the following format, for example: 0x010102
8
- */
9
- addAvailableContentType(contentTypeId: string): Promise<IContentTypeAddResult>;
10
- /**
11
- * Gets a ContentType by content type id
12
- * @param id The id of the content type to get, in the following format, for example: 0x010102
13
- */
14
- getById(id: string): IContentType;
15
- /**
16
- * Adds a new content type to the collection
17
- *
18
- * @param id The desired content type id for the new content type (also determines the parent content type)
19
- * @param name The name of the content type
20
- * @param description The description of the content type
21
- * @param group The group in which to add the content type
22
- * @param additionalSettings Any additional settings to provide when creating the content type
23
- *
24
- */
25
- add(id: string, name: string, description?: string, group?: string, additionalSettings?: ITypedHash<string | number | boolean>): Promise<IContentTypeAddResult>;
26
- }
27
- export interface IContentTypes extends _ContentTypes {
28
- }
29
- export declare const ContentTypes: import("../sharepointqueryable.js").ISPInvokableFactory<IContentTypes>;
30
- export declare class _ContentType extends _SharePointQueryableInstance<IContentTypeInfo> {
31
- delete: (this: import("../sharepointqueryable.js").ISharePointQueryable<any>) => Promise<void>;
32
- /**
33
- * Gets the column (also known as field) references in the content type.
34
- */
35
- get fieldLinks(): IFieldLinks;
36
- /**
37
- * Gets a value that specifies the collection of fields for the content type.
38
- */
39
- get fields(): ISharePointQueryableCollection;
40
- /**
41
- * Gets the parent content type of the content type.
42
- */
43
- get parent(): IContentType;
44
- /**
45
- * Gets a value that specifies the collection of workflow associations for the content type.
46
- */
47
- get workflowAssociations(): ISharePointQueryableCollection;
48
- }
49
- export interface IContentType extends _ContentType, IDeleteable {
50
- }
51
- export declare const ContentType: import("../sharepointqueryable.js").ISPInvokableFactory<IContentType>;
52
- /**
53
- * Represents the output of adding a content type
54
- */
55
- export interface IContentTypeAddResult {
56
- contentType: IContentType;
57
- data: Partial<IContentTypeInfo>;
58
- }
59
- export interface IContentTypeInfo {
60
- Description: string;
61
- DisplayFormTemplateName: string;
62
- DisplayFormUrl: string;
63
- DocumentTemplate: string;
64
- DocumentTemplateUrl: string;
65
- EditFormTemplateName: string;
66
- EditFormUrl: string;
67
- Group: string;
68
- Hidden: boolean;
69
- Id: {
70
- StringValue: string;
71
- };
72
- JSLink: string;
73
- MobileDisplayFormUrl: string;
74
- MobileEditFormUrl: string;
75
- MobileNewFormUrl: string;
76
- Name: string;
77
- NewFormTemplateName: string;
78
- NewFormUrl: string;
79
- ReadOnly: boolean;
80
- SchemaXml: string;
81
- Scope: string;
82
- Sealed: boolean;
83
- StringId: string;
84
- }
85
- export declare class _FieldLinks extends _SharePointQueryableCollection<IFieldLinkInfo[]> {
86
- /**
87
- * Gets a FieldLink by GUID id
88
- *
89
- * @param id The GUID id of the field link
90
- */
91
- getById(id: string): IFieldLink;
92
- }
93
- export interface IFieldLinks extends _FieldLinks {
94
- }
95
- export declare const FieldLinks: import("../sharepointqueryable.js").ISPInvokableFactory<IFieldLinks>;
96
- export declare class _FieldLink extends _SharePointQueryableInstance<IFieldLinkInfo> {
97
- }
98
- export interface IFieldLink extends _FieldLink {
99
- }
100
- export declare const FieldLink: import("../sharepointqueryable.js").ISPInvokableFactory<IFieldLink>;
101
- export interface IFieldLinkInfo {
102
- FieldInternalName: string | null;
103
- Hidden: boolean;
104
- Id: string;
105
- Name: string;
106
- Required: boolean;
107
- }
1
+ import { ITypedHash } from "@pnp/common";
2
+ import { _SharePointQueryableInstance, ISharePointQueryableCollection, _SharePointQueryableCollection, IDeleteable } from "../sharepointqueryable.js";
3
+ export declare class _ContentTypes extends _SharePointQueryableCollection<IContentTypeInfo[]> {
4
+ /**
5
+ * Adds an existing contenttype to a content type collection
6
+ *
7
+ * @param contentTypeId in the following format, for example: 0x010102
8
+ */
9
+ addAvailableContentType(contentTypeId: string): Promise<IContentTypeAddResult>;
10
+ /**
11
+ * Gets a ContentType by content type id
12
+ * @param id The id of the content type to get, in the following format, for example: 0x010102
13
+ */
14
+ getById(id: string): IContentType;
15
+ /**
16
+ * Adds a new content type to the collection
17
+ *
18
+ * @param id The desired content type id for the new content type (also determines the parent content type)
19
+ * @param name The name of the content type
20
+ * @param description The description of the content type
21
+ * @param group The group in which to add the content type
22
+ * @param additionalSettings Any additional settings to provide when creating the content type
23
+ *
24
+ */
25
+ add(id: string, name: string, description?: string, group?: string, additionalSettings?: ITypedHash<string | number | boolean>): Promise<IContentTypeAddResult>;
26
+ }
27
+ export interface IContentTypes extends _ContentTypes {
28
+ }
29
+ export declare const ContentTypes: import("../sharepointqueryable.js").ISPInvokableFactory<IContentTypes>;
30
+ export declare class _ContentType extends _SharePointQueryableInstance<IContentTypeInfo> {
31
+ delete: (this: import("../sharepointqueryable.js").ISharePointQueryable<any>) => Promise<void>;
32
+ /**
33
+ * Gets the column (also known as field) references in the content type.
34
+ */
35
+ get fieldLinks(): IFieldLinks;
36
+ /**
37
+ * Gets a value that specifies the collection of fields for the content type.
38
+ */
39
+ get fields(): ISharePointQueryableCollection;
40
+ /**
41
+ * Gets the parent content type of the content type.
42
+ */
43
+ get parent(): IContentType;
44
+ /**
45
+ * Gets a value that specifies the collection of workflow associations for the content type.
46
+ */
47
+ get workflowAssociations(): ISharePointQueryableCollection;
48
+ }
49
+ export interface IContentType extends _ContentType, IDeleteable {
50
+ }
51
+ export declare const ContentType: import("../sharepointqueryable.js").ISPInvokableFactory<IContentType>;
52
+ /**
53
+ * Represents the output of adding a content type
54
+ */
55
+ export interface IContentTypeAddResult {
56
+ contentType: IContentType;
57
+ data: Partial<IContentTypeInfo>;
58
+ }
59
+ export interface IContentTypeInfo {
60
+ Description: string;
61
+ DisplayFormTemplateName: string;
62
+ DisplayFormUrl: string;
63
+ DocumentTemplate: string;
64
+ DocumentTemplateUrl: string;
65
+ EditFormTemplateName: string;
66
+ EditFormUrl: string;
67
+ Group: string;
68
+ Hidden: boolean;
69
+ Id: {
70
+ StringValue: string;
71
+ };
72
+ JSLink: string;
73
+ MobileDisplayFormUrl: string;
74
+ MobileEditFormUrl: string;
75
+ MobileNewFormUrl: string;
76
+ Name: string;
77
+ NewFormTemplateName: string;
78
+ NewFormUrl: string;
79
+ ReadOnly: boolean;
80
+ SchemaXml: string;
81
+ Scope: string;
82
+ Sealed: boolean;
83
+ StringId: string;
84
+ }
85
+ export declare class _FieldLinks extends _SharePointQueryableCollection<IFieldLinkInfo[]> {
86
+ /**
87
+ * Gets a FieldLink by GUID id
88
+ *
89
+ * @param id The GUID id of the field link
90
+ */
91
+ getById(id: string): IFieldLink;
92
+ }
93
+ export interface IFieldLinks extends _FieldLinks {
94
+ }
95
+ export declare const FieldLinks: import("../sharepointqueryable.js").ISPInvokableFactory<IFieldLinks>;
96
+ export declare class _FieldLink extends _SharePointQueryableInstance<IFieldLinkInfo> {
97
+ }
98
+ export interface IFieldLink extends _FieldLink {
99
+ }
100
+ export declare const FieldLink: import("../sharepointqueryable.js").ISPInvokableFactory<IFieldLink>;
101
+ export interface IFieldLinkInfo {
102
+ FieldInternalName: string | null;
103
+ Hidden: boolean;
104
+ Id: string;
105
+ Name: string;
106
+ Required: boolean;
107
+ }
108
108
  //# sourceMappingURL=types.d.ts.map
@@ -1,167 +1,167 @@
1
- import { __awaiter, __decorate, __extends, __generator } from "tslib";
2
- import { body } from "@pnp/odata";
3
- import { SharePointQueryableCollection, _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, deleteable, } from "../sharepointqueryable.js";
4
- import { defaultPath } from "../decorators.js";
5
- import { metadata } from "../utils/metadata.js";
6
- import { spPost } from "../operations.js";
7
- import { tag } from "../telemetry.js";
8
- var _ContentTypes = /** @class */ (function (_super) {
9
- __extends(_ContentTypes, _super);
10
- function _ContentTypes() {
11
- return _super !== null && _super.apply(this, arguments) || this;
12
- }
13
- /**
14
- * Adds an existing contenttype to a content type collection
15
- *
16
- * @param contentTypeId in the following format, for example: 0x010102
17
- */
18
- _ContentTypes.prototype.addAvailableContentType = function (contentTypeId) {
19
- return __awaiter(this, void 0, void 0, function () {
20
- var data;
21
- return __generator(this, function (_a) {
22
- switch (_a.label) {
23
- case 0: return [4 /*yield*/, spPost(this.clone(ContentTypes, "addAvailableContentType"), body({ "contentTypeId": contentTypeId }))];
24
- case 1:
25
- data = _a.sent();
26
- return [2 /*return*/, {
27
- contentType: this.getById(data.id),
28
- data: data,
29
- }];
30
- }
31
- });
32
- });
33
- };
34
- /**
35
- * Gets a ContentType by content type id
36
- * @param id The id of the content type to get, in the following format, for example: 0x010102
37
- */
38
- _ContentTypes.prototype.getById = function (id) {
39
- return tag.configure(ContentType(this).concat("('" + id + "')"), "cts.getById");
40
- };
41
- /**
42
- * Adds a new content type to the collection
43
- *
44
- * @param id The desired content type id for the new content type (also determines the parent content type)
45
- * @param name The name of the content type
46
- * @param description The description of the content type
47
- * @param group The group in which to add the content type
48
- * @param additionalSettings Any additional settings to provide when creating the content type
49
- *
50
- */
51
- _ContentTypes.prototype.add = function (id, name, description, group, additionalSettings) {
52
- if (description === void 0) { description = ""; }
53
- if (group === void 0) { group = "Custom Content Types"; }
54
- if (additionalSettings === void 0) { additionalSettings = {}; }
55
- return __awaiter(this, void 0, void 0, function () {
56
- var postBody, data;
57
- return __generator(this, function (_a) {
58
- switch (_a.label) {
59
- case 0:
60
- postBody = body(Object.assign(metadata("SP.ContentType"), {
61
- "Description": description,
62
- "Group": group,
63
- "Id": { "StringValue": id },
64
- "Name": name,
65
- }, additionalSettings));
66
- return [4 /*yield*/, spPost(this, postBody)];
67
- case 1:
68
- data = _a.sent();
69
- return [2 /*return*/, { contentType: this.getById(data.id), data: data }];
70
- }
71
- });
72
- });
73
- };
74
- __decorate([
75
- tag("cts.addAvailableContentType")
76
- ], _ContentTypes.prototype, "addAvailableContentType", null);
77
- __decorate([
78
- tag("cts.add")
79
- ], _ContentTypes.prototype, "add", null);
80
- _ContentTypes = __decorate([
81
- defaultPath("contenttypes")
82
- ], _ContentTypes);
83
- return _ContentTypes;
84
- }(_SharePointQueryableCollection));
85
- export { _ContentTypes };
86
- export var ContentTypes = spInvokableFactory(_ContentTypes);
87
- var _ContentType = /** @class */ (function (_super) {
88
- __extends(_ContentType, _super);
89
- function _ContentType() {
90
- var _this = _super !== null && _super.apply(this, arguments) || this;
91
- _this.delete = deleteable("ct");
92
- return _this;
93
- }
94
- Object.defineProperty(_ContentType.prototype, "fieldLinks", {
95
- /**
96
- * Gets the column (also known as field) references in the content type.
97
- */
98
- get: function () {
99
- return tag.configure(FieldLinks(this), "ct.fieldLinks");
100
- },
101
- enumerable: false,
102
- configurable: true
103
- });
104
- Object.defineProperty(_ContentType.prototype, "fields", {
105
- /**
106
- * Gets a value that specifies the collection of fields for the content type.
107
- */
108
- get: function () {
109
- return tag.configure(SharePointQueryableCollection(this, "fields"), "ct.fields");
110
- },
111
- enumerable: false,
112
- configurable: true
113
- });
114
- Object.defineProperty(_ContentType.prototype, "parent", {
115
- /**
116
- * Gets the parent content type of the content type.
117
- */
118
- get: function () {
119
- return tag.configure(ContentType(this, "parent"), "ct.parent");
120
- },
121
- enumerable: false,
122
- configurable: true
123
- });
124
- Object.defineProperty(_ContentType.prototype, "workflowAssociations", {
125
- /**
126
- * Gets a value that specifies the collection of workflow associations for the content type.
127
- */
128
- get: function () {
129
- return tag.configure(SharePointQueryableCollection(this, "workflowAssociations"), "ct.workflowAssociations");
130
- },
131
- enumerable: false,
132
- configurable: true
133
- });
134
- return _ContentType;
135
- }(_SharePointQueryableInstance));
136
- export { _ContentType };
137
- export var ContentType = spInvokableFactory(_ContentType);
138
- var _FieldLinks = /** @class */ (function (_super) {
139
- __extends(_FieldLinks, _super);
140
- function _FieldLinks() {
141
- return _super !== null && _super.apply(this, arguments) || this;
142
- }
143
- /**
144
- * Gets a FieldLink by GUID id
145
- *
146
- * @param id The GUID id of the field link
147
- */
148
- _FieldLinks.prototype.getById = function (id) {
149
- return tag.configure(FieldLink(this).concat("(guid'" + id + "')"), "fls.getById");
150
- };
151
- _FieldLinks = __decorate([
152
- defaultPath("fieldlinks")
153
- ], _FieldLinks);
154
- return _FieldLinks;
155
- }(_SharePointQueryableCollection));
156
- export { _FieldLinks };
157
- export var FieldLinks = spInvokableFactory(_FieldLinks);
158
- var _FieldLink = /** @class */ (function (_super) {
159
- __extends(_FieldLink, _super);
160
- function _FieldLink() {
161
- return _super !== null && _super.apply(this, arguments) || this;
162
- }
163
- return _FieldLink;
164
- }(_SharePointQueryableInstance));
165
- export { _FieldLink };
166
- export var FieldLink = spInvokableFactory(_FieldLink);
1
+ import { __awaiter, __decorate, __extends, __generator } from "tslib";
2
+ import { body } from "@pnp/odata";
3
+ import { SharePointQueryableCollection, _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, deleteable, } from "../sharepointqueryable.js";
4
+ import { defaultPath } from "../decorators.js";
5
+ import { metadata } from "../utils/metadata.js";
6
+ import { spPost } from "../operations.js";
7
+ import { tag } from "../telemetry.js";
8
+ var _ContentTypes = /** @class */ (function (_super) {
9
+ __extends(_ContentTypes, _super);
10
+ function _ContentTypes() {
11
+ return _super !== null && _super.apply(this, arguments) || this;
12
+ }
13
+ /**
14
+ * Adds an existing contenttype to a content type collection
15
+ *
16
+ * @param contentTypeId in the following format, for example: 0x010102
17
+ */
18
+ _ContentTypes.prototype.addAvailableContentType = function (contentTypeId) {
19
+ return __awaiter(this, void 0, void 0, function () {
20
+ var data;
21
+ return __generator(this, function (_a) {
22
+ switch (_a.label) {
23
+ case 0: return [4 /*yield*/, spPost(this.clone(ContentTypes, "addAvailableContentType"), body({ "contentTypeId": contentTypeId }))];
24
+ case 1:
25
+ data = _a.sent();
26
+ return [2 /*return*/, {
27
+ contentType: this.getById(data.id),
28
+ data: data,
29
+ }];
30
+ }
31
+ });
32
+ });
33
+ };
34
+ /**
35
+ * Gets a ContentType by content type id
36
+ * @param id The id of the content type to get, in the following format, for example: 0x010102
37
+ */
38
+ _ContentTypes.prototype.getById = function (id) {
39
+ return tag.configure(ContentType(this).concat("('" + id + "')"), "cts.getById");
40
+ };
41
+ /**
42
+ * Adds a new content type to the collection
43
+ *
44
+ * @param id The desired content type id for the new content type (also determines the parent content type)
45
+ * @param name The name of the content type
46
+ * @param description The description of the content type
47
+ * @param group The group in which to add the content type
48
+ * @param additionalSettings Any additional settings to provide when creating the content type
49
+ *
50
+ */
51
+ _ContentTypes.prototype.add = function (id, name, description, group, additionalSettings) {
52
+ if (description === void 0) { description = ""; }
53
+ if (group === void 0) { group = "Custom Content Types"; }
54
+ if (additionalSettings === void 0) { additionalSettings = {}; }
55
+ return __awaiter(this, void 0, void 0, function () {
56
+ var postBody, data;
57
+ return __generator(this, function (_a) {
58
+ switch (_a.label) {
59
+ case 0:
60
+ postBody = body(Object.assign(metadata("SP.ContentType"), {
61
+ "Description": description,
62
+ "Group": group,
63
+ "Id": { "StringValue": id },
64
+ "Name": name,
65
+ }, additionalSettings));
66
+ return [4 /*yield*/, spPost(this, postBody)];
67
+ case 1:
68
+ data = _a.sent();
69
+ return [2 /*return*/, { contentType: this.getById(data.id), data: data }];
70
+ }
71
+ });
72
+ });
73
+ };
74
+ __decorate([
75
+ tag("cts.addAvailableContentType")
76
+ ], _ContentTypes.prototype, "addAvailableContentType", null);
77
+ __decorate([
78
+ tag("cts.add")
79
+ ], _ContentTypes.prototype, "add", null);
80
+ _ContentTypes = __decorate([
81
+ defaultPath("contenttypes")
82
+ ], _ContentTypes);
83
+ return _ContentTypes;
84
+ }(_SharePointQueryableCollection));
85
+ export { _ContentTypes };
86
+ export var ContentTypes = spInvokableFactory(_ContentTypes);
87
+ var _ContentType = /** @class */ (function (_super) {
88
+ __extends(_ContentType, _super);
89
+ function _ContentType() {
90
+ var _this = _super !== null && _super.apply(this, arguments) || this;
91
+ _this.delete = deleteable("ct");
92
+ return _this;
93
+ }
94
+ Object.defineProperty(_ContentType.prototype, "fieldLinks", {
95
+ /**
96
+ * Gets the column (also known as field) references in the content type.
97
+ */
98
+ get: function () {
99
+ return tag.configure(FieldLinks(this), "ct.fieldLinks");
100
+ },
101
+ enumerable: false,
102
+ configurable: true
103
+ });
104
+ Object.defineProperty(_ContentType.prototype, "fields", {
105
+ /**
106
+ * Gets a value that specifies the collection of fields for the content type.
107
+ */
108
+ get: function () {
109
+ return tag.configure(SharePointQueryableCollection(this, "fields"), "ct.fields");
110
+ },
111
+ enumerable: false,
112
+ configurable: true
113
+ });
114
+ Object.defineProperty(_ContentType.prototype, "parent", {
115
+ /**
116
+ * Gets the parent content type of the content type.
117
+ */
118
+ get: function () {
119
+ return tag.configure(ContentType(this, "parent"), "ct.parent");
120
+ },
121
+ enumerable: false,
122
+ configurable: true
123
+ });
124
+ Object.defineProperty(_ContentType.prototype, "workflowAssociations", {
125
+ /**
126
+ * Gets a value that specifies the collection of workflow associations for the content type.
127
+ */
128
+ get: function () {
129
+ return tag.configure(SharePointQueryableCollection(this, "workflowAssociations"), "ct.workflowAssociations");
130
+ },
131
+ enumerable: false,
132
+ configurable: true
133
+ });
134
+ return _ContentType;
135
+ }(_SharePointQueryableInstance));
136
+ export { _ContentType };
137
+ export var ContentType = spInvokableFactory(_ContentType);
138
+ var _FieldLinks = /** @class */ (function (_super) {
139
+ __extends(_FieldLinks, _super);
140
+ function _FieldLinks() {
141
+ return _super !== null && _super.apply(this, arguments) || this;
142
+ }
143
+ /**
144
+ * Gets a FieldLink by GUID id
145
+ *
146
+ * @param id The GUID id of the field link
147
+ */
148
+ _FieldLinks.prototype.getById = function (id) {
149
+ return tag.configure(FieldLink(this).concat("(guid'" + id + "')"), "fls.getById");
150
+ };
151
+ _FieldLinks = __decorate([
152
+ defaultPath("fieldlinks")
153
+ ], _FieldLinks);
154
+ return _FieldLinks;
155
+ }(_SharePointQueryableCollection));
156
+ export { _FieldLinks };
157
+ export var FieldLinks = spInvokableFactory(_FieldLinks);
158
+ var _FieldLink = /** @class */ (function (_super) {
159
+ __extends(_FieldLink, _super);
160
+ function _FieldLink() {
161
+ return _super !== null && _super.apply(this, arguments) || this;
162
+ }
163
+ return _FieldLink;
164
+ }(_SharePointQueryableInstance));
165
+ export { _FieldLink };
166
+ export var FieldLink = spInvokableFactory(_FieldLink);
167
167
  //# sourceMappingURL=types.js.map
@@ -1,13 +1,13 @@
1
- import { IContentTypes } from "./types.js";
2
- declare module "../webs/types" {
3
- interface _Web {
4
- readonly contentTypes: IContentTypes;
5
- }
6
- interface IWeb {
7
- /**
8
- * Content types contained in this web
9
- */
10
- readonly contentTypes: IContentTypes;
11
- }
12
- }
1
+ import { IContentTypes } from "./types.js";
2
+ declare module "../webs/types" {
3
+ interface _Web {
4
+ readonly contentTypes: IContentTypes;
5
+ }
6
+ interface IWeb {
7
+ /**
8
+ * Content types contained in this web
9
+ */
10
+ readonly contentTypes: IContentTypes;
11
+ }
12
+ }
13
13
  //# sourceMappingURL=web.d.ts.map
@@ -1,5 +1,5 @@
1
- import { addProp } from "@pnp/odata";
2
- import { _Web } from "../webs/types.js";
3
- import { ContentTypes } from "./types.js";
4
- addProp(_Web, "contentTypes", ContentTypes);
1
+ import { addProp } from "@pnp/odata";
2
+ import { _Web } from "../webs/types.js";
3
+ import { ContentTypes } from "./types.js";
4
+ addProp(_Web, "contentTypes", ContentTypes);
5
5
  //# sourceMappingURL=web.js.map
package/decorators.d.ts CHANGED
@@ -1,12 +1,12 @@
1
- /**
2
- * Class Decorators
3
- */
4
- /**
5
- * Decorator used to specify the default path for SharePointQueryable objects
6
- *
7
- * @param path
8
- */
9
- export declare function defaultPath(path: string): <T extends new (...args: any[]) => {}>(target: T) => {
10
- new (...args: any[]): {};
11
- } & T;
1
+ /**
2
+ * Class Decorators
3
+ */
4
+ /**
5
+ * Decorator used to specify the default path for SharePointQueryable objects
6
+ *
7
+ * @param path
8
+ */
9
+ export declare function defaultPath(path: string): <T extends new (...args: any[]) => {}>(target: T) => {
10
+ new (...args: any[]): {};
11
+ } & T;
12
12
  //# sourceMappingURL=decorators.d.ts.map