@pnp/sp 2.7.0 → 2.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +25 -25
- package/appcatalog/index.d.ts +8 -8
- package/appcatalog/index.js +30 -30
- package/appcatalog/types.d.ts +81 -81
- package/appcatalog/types.js +177 -177
- package/appcatalog/web.d.ts +16 -16
- package/appcatalog/web.js +6 -6
- package/attachments/index.d.ts +2 -2
- package/attachments/index.js +2 -2
- package/attachments/item.d.ts +12 -12
- package/attachments/item.js +4 -4
- package/attachments/types.d.ts +92 -92
- package/attachments/types.js +240 -240
- package/batch.d.ts +17 -17
- package/batch.js +223 -223
- package/batch.js.map +1 -1
- package/clientside-pages/funcs.d.ts +22 -22
- package/clientside-pages/funcs.js +25 -25
- package/clientside-pages/index.d.ts +2 -2
- package/clientside-pages/index.js +2 -2
- package/clientside-pages/types.d.ts +496 -494
- package/clientside-pages/types.d.ts.map +1 -1
- package/clientside-pages/types.js +1496 -1485
- package/clientside-pages/types.js.map +1 -1
- package/clientside-pages/web.d.ts +41 -41
- package/clientside-pages/web.js +57 -57
- package/column-defaults/folder.d.ts +27 -27
- package/column-defaults/folder.js +82 -82
- package/column-defaults/index.d.ts +3 -3
- package/column-defaults/index.js +2 -2
- package/column-defaults/list.d.ts +19 -19
- package/column-defaults/list.js +198 -198
- package/column-defaults/types.d.ts +21 -21
- package/column-defaults/types.js +1 -1
- package/comments/clientside-page.d.ts +57 -57
- package/comments/clientside-page.d.ts.map +1 -1
- package/comments/clientside-page.js +136 -136
- package/comments/index.d.ts +2 -2
- package/comments/index.js +2 -2
- package/comments/item.d.ts +29 -29
- package/comments/item.js +47 -47
- package/comments/types.d.ts +107 -107
- package/comments/types.d.ts.map +1 -1
- package/comments/types.js +145 -145
- package/comments/types.js.map +1 -1
- package/content-types/index.d.ts +4 -4
- package/content-types/index.js +4 -4
- package/content-types/item.d.ts +12 -12
- package/content-types/item.js +4 -4
- package/content-types/list.d.ts +12 -12
- package/content-types/list.js +4 -4
- package/content-types/types.d.ts +107 -107
- package/content-types/types.js +166 -166
- package/content-types/web.d.ts +12 -12
- package/content-types/web.js +4 -4
- package/decorators.d.ts +11 -11
- package/decorators.js +28 -28
- package/features/index.d.ts +3 -3
- package/features/index.js +3 -3
- package/features/site.d.ts +12 -12
- package/features/site.js +4 -4
- package/features/types.d.ts +47 -47
- package/features/types.js +109 -109
- package/features/web.d.ts +12 -12
- package/features/web.js +4 -4
- package/fields/index.d.ts +4 -4
- package/fields/index.js +4 -4
- package/fields/list.d.ts +12 -12
- package/fields/list.js +4 -4
- package/fields/types.d.ts +368 -361
- package/fields/types.d.ts.map +1 -1
- package/fields/types.js +624 -609
- package/fields/types.js.map +1 -1
- package/fields/web.d.ts +17 -17
- package/fields/web.js +5 -5
- package/files/folder.d.ts +12 -12
- package/files/folder.js +4 -4
- package/files/index.d.ts +4 -4
- package/files/index.js +4 -4
- package/files/item.d.ts +12 -12
- package/files/item.js +4 -4
- package/files/types.d.ts +421 -421
- package/files/types.js +853 -853
- package/files/types.js.map +1 -1
- package/files/web.d.ts +35 -35
- package/files/web.js +15 -15
- package/folders/index.d.ts +4 -4
- package/folders/index.js +4 -4
- package/folders/item.d.ts +9 -9
- package/folders/item.js +4 -4
- package/folders/list.d.ts +12 -12
- package/folders/list.js +4 -4
- package/folders/types.d.ts +207 -207
- package/folders/types.js +433 -433
- package/folders/types.js.map +1 -1
- package/folders/web.d.ts +39 -39
- package/folders/web.js +15 -15
- package/forms/index.d.ts +2 -2
- package/forms/index.js +2 -2
- package/forms/list.d.ts +9 -9
- package/forms/list.js +4 -4
- package/forms/types.d.ts +35 -35
- package/forms/types.js +41 -41
- package/hubsites/index.d.ts +12 -12
- package/hubsites/index.js +15 -15
- package/hubsites/site.d.ts +26 -26
- package/hubsites/site.js +39 -39
- package/hubsites/types.d.ts +55 -55
- package/hubsites/types.js +53 -53
- package/hubsites/web.d.ts +21 -21
- package/hubsites/web.js +23 -23
- package/index.d.ts +14 -14
- package/index.js +13 -13
- package/items/index.d.ts +2 -2
- package/items/index.js +2 -2
- package/items/list.d.ts +9 -9
- package/items/list.js +4 -4
- package/items/types.d.ts +226 -219
- package/items/types.d.ts.map +1 -1
- package/items/types.js +549 -511
- package/items/types.js.map +1 -1
- package/lists/index.d.ts +2 -2
- package/lists/index.js +2 -2
- package/lists/types.d.ts +495 -495
- package/lists/types.js +522 -522
- package/lists/types.js.map +1 -1
- package/lists/web.d.ts +43 -43
- package/lists/web.js +27 -27
- package/navigation/index.d.ts +8 -8
- package/navigation/index.js +14 -14
- package/navigation/types.d.ts +154 -154
- package/navigation/types.js +219 -219
- package/navigation/web.d.ts +13 -13
- package/navigation/web.js +4 -4
- package/odata.d.ts +5 -5
- package/odata.js +90 -90
- package/odata.js.map +1 -1
- package/operations.d.ts +9 -9
- package/operations.js +63 -63
- package/package.json +4 -4
- package/presets/all.d.ts +72 -72
- package/presets/all.js +72 -72
- package/presets/core.d.ts +11 -11
- package/presets/core.js +11 -11
- package/profiles/index.d.ts +7 -7
- package/profiles/index.js +13 -13
- package/profiles/types.d.ts +357 -357
- package/profiles/types.js +454 -454
- package/readme.md +21 -21
- package/regional-settings/content-type.d.ts +7 -7
- package/regional-settings/content-type.js +4 -4
- package/regional-settings/field.d.ts +7 -7
- package/regional-settings/field.js +4 -4
- package/regional-settings/funcs.d.ts +2 -2
- package/regional-settings/funcs.js +8 -8
- package/regional-settings/index.d.ts +6 -6
- package/regional-settings/index.js +6 -6
- package/regional-settings/list.d.ts +7 -7
- package/regional-settings/list.js +4 -4
- package/regional-settings/types.d.ts +111 -111
- package/regional-settings/types.js +159 -159
- package/regional-settings/user-custom-actions.d.ts +7 -7
- package/regional-settings/user-custom-actions.js +4 -4
- package/regional-settings/web.d.ts +12 -12
- package/regional-settings/web.js +7 -7
- package/related-items/index.d.ts +1 -1
- package/related-items/index.js +1 -1
- package/related-items/types.d.ts +76 -76
- package/related-items/types.js +103 -103
- package/related-items/web.d.ts +12 -12
- package/related-items/web.js +9 -9
- package/rest.d.ts +44 -44
- package/rest.js +72 -72
- package/search/index.d.ts +30 -30
- package/search/index.js +25 -25
- package/search/query.d.ts +62 -62
- package/search/query.js +302 -302
- package/search/suggest.d.ts +76 -76
- package/search/suggest.js +66 -66
- package/search/types.d.ts +426 -426
- package/search/types.js +57 -57
- package/security/funcs.d.ts +43 -43
- package/security/funcs.js +142 -142
- package/security/index.d.ts +4 -4
- package/security/index.js +4 -4
- package/security/item.d.ts +7 -7
- package/security/item.js +14 -14
- package/security/list.d.ts +7 -7
- package/security/list.js +14 -14
- package/security/types.d.ts +318 -318
- package/security/types.js +399 -399
- package/security/web.d.ts +9 -9
- package/security/web.js +15 -15
- package/sharepointqueryable.d.ts +135 -135
- package/sharepointqueryable.js +265 -265
- package/sharing/file.d.ts +18 -18
- package/sharing/file.d.ts.map +1 -1
- package/sharing/file.js +116 -15
- package/sharing/file.js.map +1 -1
- package/sharing/folder.d.ts +9 -9
- package/sharing/folder.js +136 -136
- package/sharing/funcs.d.ts +62 -62
- package/sharing/funcs.js +239 -239
- package/sharing/funcs.js.map +1 -1
- package/sharing/index.d.ts +5 -5
- package/sharing/index.js +5 -5
- package/sharing/item.d.ts +16 -16
- package/sharing/item.js +15 -15
- package/sharing/types.d.ts +583 -583
- package/sharing/types.js +113 -113
- package/sharing/web.d.ts +19 -19
- package/sharing/web.js +76 -76
- package/site-designs/index.d.ts +8 -8
- package/site-designs/index.js +14 -14
- package/site-designs/types.d.ts +319 -319
- package/site-designs/types.js +203 -203
- package/site-designs/web.d.ts +25 -25
- package/site-designs/web.js +11 -11
- package/site-groups/index.d.ts +2 -2
- package/site-groups/index.js +2 -2
- package/site-groups/types.d.ts +89 -89
- package/site-groups/types.js +125 -125
- package/site-groups/web.d.ts +40 -40
- package/site-groups/web.js +30 -30
- package/site-scripts/index.d.ts +9 -9
- package/site-scripts/index.js +15 -15
- package/site-scripts/list.d.ts +12 -12
- package/site-scripts/list.js +24 -24
- package/site-scripts/types.d.ts +183 -183
- package/site-scripts/types.js +141 -141
- package/site-scripts/web.d.ts +13 -13
- package/site-scripts/web.js +5 -5
- package/site-users/index.d.ts +2 -2
- package/site-users/index.js +2 -2
- package/site-users/types.d.ts +138 -138
- package/site-users/types.js +122 -122
- package/site-users/web.d.ts +31 -31
- package/site-users/web.js +27 -27
- package/sites/index.d.ts +7 -7
- package/sites/index.js +13 -13
- package/sites/types.d.ts +147 -147
- package/sites/types.js +321 -321
- package/social/index.d.ts +10 -10
- package/social/index.js +13 -13
- package/social/types.d.ts +309 -309
- package/social/types.js +322 -322
- package/sphttpclient.d.ts +18 -18
- package/sphttpclient.js +189 -189
- package/splibconfig.d.ts +22 -22
- package/splibconfig.js +13 -13
- package/sputilities/index.d.ts +7 -7
- package/sputilities/index.js +13 -13
- package/sputilities/types.d.ts +130 -130
- package/sputilities/types.js +118 -118
- package/subscriptions/index.d.ts +2 -2
- package/subscriptions/index.js +2 -2
- package/subscriptions/list.d.ts +13 -13
- package/subscriptions/list.js +4 -4
- package/subscriptions/types.d.ts +54 -54
- package/subscriptions/types.js +111 -111
- package/taxonomy/index.d.ts +7 -7
- package/taxonomy/index.js +13 -13
- package/taxonomy/types.d.ts +200 -200
- package/taxonomy/types.js +347 -347
- package/taxonomy/types.js.map +1 -1
- package/telemetry.d.ts +12 -12
- package/telemetry.js +48 -48
- package/types.d.ts +218 -218
- package/types.js +79 -79
- package/user-custom-actions/index.d.ts +4 -4
- package/user-custom-actions/index.js +4 -4
- package/user-custom-actions/list.d.ts +12 -12
- package/user-custom-actions/list.js +4 -4
- package/user-custom-actions/site.d.ts +12 -12
- package/user-custom-actions/site.js +4 -4
- package/user-custom-actions/types.d.ts +82 -82
- package/user-custom-actions/types.js +93 -93
- package/user-custom-actions/web.d.ts +15 -15
- package/user-custom-actions/web.js +4 -4
- package/utils/escapeQueryStrValue.d.ts +1 -1
- package/utils/escapeQueryStrValue.js +19 -19
- package/utils/extractweburl.d.ts +1 -1
- package/utils/extractweburl.js +15 -15
- package/utils/file-names.d.ts +17 -17
- package/utils/file-names.js +38 -38
- package/utils/metadata.d.ts +5 -5
- package/utils/metadata.js +5 -5
- package/utils/objectToSPKeyValueCollection.d.ts +20 -20
- package/utils/objectToSPKeyValueCollection.js +16 -16
- package/utils/toResourcePath.d.ts +7 -7
- package/utils/toResourcePath.js +6 -6
- package/utils/toabsoluteurl.d.ts +7 -7
- package/utils/toabsoluteurl.js +61 -61
- package/views/index.d.ts +2 -2
- package/views/index.js +2 -2
- package/views/list.d.ts +23 -23
- package/views/list.js +8 -8
- package/views/types.d.ts +140 -140
- package/views/types.js +184 -184
- package/webparts/file.d.ts +15 -15
- package/webparts/file.js +6 -6
- package/webparts/index.d.ts +2 -2
- package/webparts/index.js +2 -2
- package/webparts/types.d.ts +83 -83
- package/webparts/types.js +117 -117
- package/webs/index.d.ts +16 -16
- package/webs/index.js +16 -16
- package/webs/types.d.ts +210 -210
- package/webs/types.js +295 -295
package/attachments/types.js
CHANGED
|
@@ -1,241 +1,241 @@
|
|
|
1
|
-
import { __awaiter, __decorate, __extends, __generator } from "tslib";
|
|
2
|
-
import { defaultPath } from "../decorators.js";
|
|
3
|
-
import { spPost } from "../operations.js";
|
|
4
|
-
import { _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, deleteableWithETag, } from "../sharepointqueryable.js";
|
|
5
|
-
import { TextParser, BlobParser, JSONParser, BufferParser, headers } from "@pnp/odata";
|
|
6
|
-
import { tag } from "../telemetry.js";
|
|
7
|
-
var _Attachments = /** @class */ (function (_super) {
|
|
8
|
-
__extends(_Attachments, _super);
|
|
9
|
-
function _Attachments() {
|
|
10
|
-
return _super !== null && _super.apply(this, arguments) || this;
|
|
11
|
-
}
|
|
12
|
-
/**
|
|
13
|
-
* Gets a Attachment File by filename
|
|
14
|
-
*
|
|
15
|
-
* @param name The name of the file, including extension.
|
|
16
|
-
*/
|
|
17
|
-
_Attachments.prototype.getByName = function (name) {
|
|
18
|
-
var f = tag.configure(Attachment(this), "ats.getByName");
|
|
19
|
-
f.concat("('" + name + "')");
|
|
20
|
-
return f;
|
|
21
|
-
};
|
|
22
|
-
/**
|
|
23
|
-
* Adds a new attachment to the collection. Not supported for batching.
|
|
24
|
-
*
|
|
25
|
-
* @param name The name of the file, including extension.
|
|
26
|
-
* @param content The Base64 file content.
|
|
27
|
-
*/
|
|
28
|
-
_Attachments.prototype.add = function (name, content) {
|
|
29
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
30
|
-
var response;
|
|
31
|
-
return __generator(this, function (_a) {
|
|
32
|
-
switch (_a.label) {
|
|
33
|
-
case 0: return [4 /*yield*/, spPost(this.clone(Attachments, "add(FileName='" + name + "')", false), { body: content })];
|
|
34
|
-
case 1:
|
|
35
|
-
response = _a.sent();
|
|
36
|
-
return [2 /*return*/, {
|
|
37
|
-
data: response,
|
|
38
|
-
file: this.getByName(name),
|
|
39
|
-
}];
|
|
40
|
-
}
|
|
41
|
-
});
|
|
42
|
-
});
|
|
43
|
-
};
|
|
44
|
-
/**
|
|
45
|
-
* Adds multiple new attachment to the collection. Not supported for batching.
|
|
46
|
-
*
|
|
47
|
-
* @param files The collection of files to add
|
|
48
|
-
*/
|
|
49
|
-
_Attachments.prototype.addMultiple = function (files) {
|
|
50
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
51
|
-
var i;
|
|
52
|
-
return __generator(this, function (_a) {
|
|
53
|
-
switch (_a.label) {
|
|
54
|
-
case 0:
|
|
55
|
-
i = 0;
|
|
56
|
-
_a.label = 1;
|
|
57
|
-
case 1:
|
|
58
|
-
if (!(i < files.length)) return [3 /*break*/, 4];
|
|
59
|
-
return [4 /*yield*/, this.add(files[i].name, files[i].content)];
|
|
60
|
-
case 2:
|
|
61
|
-
_a.sent();
|
|
62
|
-
_a.label = 3;
|
|
63
|
-
case 3:
|
|
64
|
-
i++;
|
|
65
|
-
return [3 /*break*/, 1];
|
|
66
|
-
case 4: return [2 /*return*/];
|
|
67
|
-
}
|
|
68
|
-
});
|
|
69
|
-
});
|
|
70
|
-
};
|
|
71
|
-
/**
|
|
72
|
-
* Delete multiple attachments from the collection. Not supported for batching.
|
|
73
|
-
*
|
|
74
|
-
* @param files The collection of files to delete
|
|
75
|
-
*/
|
|
76
|
-
_Attachments.prototype.deleteMultiple = function () {
|
|
77
|
-
var files = [];
|
|
78
|
-
for (var _i = 0; _i < arguments.length; _i++) {
|
|
79
|
-
files[_i] = arguments[_i];
|
|
80
|
-
}
|
|
81
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
82
|
-
var i;
|
|
83
|
-
return __generator(this, function (_a) {
|
|
84
|
-
switch (_a.label) {
|
|
85
|
-
case 0:
|
|
86
|
-
i = 0;
|
|
87
|
-
_a.label = 1;
|
|
88
|
-
case 1:
|
|
89
|
-
if (!(i < files.length)) return [3 /*break*/, 4];
|
|
90
|
-
return [4 /*yield*/, this.getByName(files[i]).delete()];
|
|
91
|
-
case 2:
|
|
92
|
-
_a.sent();
|
|
93
|
-
_a.label = 3;
|
|
94
|
-
case 3:
|
|
95
|
-
i++;
|
|
96
|
-
return [3 /*break*/, 1];
|
|
97
|
-
case 4: return [2 /*return*/];
|
|
98
|
-
}
|
|
99
|
-
});
|
|
100
|
-
});
|
|
101
|
-
};
|
|
102
|
-
/**
|
|
103
|
-
* Delete multiple attachments from the collection and send to recycle bin. Not supported for batching.
|
|
104
|
-
*
|
|
105
|
-
* @param files The collection of files to be deleted and sent to recycle bin
|
|
106
|
-
*/
|
|
107
|
-
_Attachments.prototype.recycleMultiple = function () {
|
|
108
|
-
var files = [];
|
|
109
|
-
for (var _i = 0; _i < arguments.length; _i++) {
|
|
110
|
-
files[_i] = arguments[_i];
|
|
111
|
-
}
|
|
112
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
113
|
-
var i;
|
|
114
|
-
return __generator(this, function (_a) {
|
|
115
|
-
switch (_a.label) {
|
|
116
|
-
case 0:
|
|
117
|
-
i = 0;
|
|
118
|
-
_a.label = 1;
|
|
119
|
-
case 1:
|
|
120
|
-
if (!(i < files.length)) return [3 /*break*/, 4];
|
|
121
|
-
return [4 /*yield*/, this.getByName(files[i]).recycle()];
|
|
122
|
-
case 2:
|
|
123
|
-
_a.sent();
|
|
124
|
-
_a.label = 3;
|
|
125
|
-
case 3:
|
|
126
|
-
i++;
|
|
127
|
-
return [3 /*break*/, 1];
|
|
128
|
-
case 4: return [2 /*return*/];
|
|
129
|
-
}
|
|
130
|
-
});
|
|
131
|
-
});
|
|
132
|
-
};
|
|
133
|
-
__decorate([
|
|
134
|
-
tag("ats.add")
|
|
135
|
-
], _Attachments.prototype, "add", null);
|
|
136
|
-
__decorate([
|
|
137
|
-
tag("ats.addMultiple")
|
|
138
|
-
], _Attachments.prototype, "addMultiple", null);
|
|
139
|
-
__decorate([
|
|
140
|
-
tag("ats.deleteMultiple")
|
|
141
|
-
], _Attachments.prototype, "deleteMultiple", null);
|
|
142
|
-
__decorate([
|
|
143
|
-
tag("ats.recycleMultiple")
|
|
144
|
-
], _Attachments.prototype, "recycleMultiple", null);
|
|
145
|
-
_Attachments = __decorate([
|
|
146
|
-
defaultPath("AttachmentFiles")
|
|
147
|
-
], _Attachments);
|
|
148
|
-
return _Attachments;
|
|
149
|
-
}(_SharePointQueryableCollection));
|
|
150
|
-
export { _Attachments };
|
|
151
|
-
export var Attachments = spInvokableFactory(_Attachments);
|
|
152
|
-
var _Attachment = /** @class */ (function (_super) {
|
|
153
|
-
__extends(_Attachment, _super);
|
|
154
|
-
function _Attachment() {
|
|
155
|
-
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
156
|
-
_this.delete = deleteableWithETag("at");
|
|
157
|
-
return _this;
|
|
158
|
-
}
|
|
159
|
-
/**
|
|
160
|
-
* Gets the contents of the file as text
|
|
161
|
-
*
|
|
162
|
-
*/
|
|
163
|
-
_Attachment.prototype.getText = function () {
|
|
164
|
-
return this.getParsed(new TextParser());
|
|
165
|
-
};
|
|
166
|
-
/**
|
|
167
|
-
* Gets the contents of the file as a blob, does not work in Node.js
|
|
168
|
-
*
|
|
169
|
-
*/
|
|
170
|
-
_Attachment.prototype.getBlob = function () {
|
|
171
|
-
return this.getParsed(new BlobParser());
|
|
172
|
-
};
|
|
173
|
-
/**
|
|
174
|
-
* Gets the contents of a file as an ArrayBuffer, works in Node.js
|
|
175
|
-
*/
|
|
176
|
-
_Attachment.prototype.getBuffer = function () {
|
|
177
|
-
return this.getParsed(new BufferParser());
|
|
178
|
-
};
|
|
179
|
-
/**
|
|
180
|
-
* Gets the contents of a file as an ArrayBuffer, works in Node.js
|
|
181
|
-
*/
|
|
182
|
-
_Attachment.prototype.getJSON = function () {
|
|
183
|
-
return this.getParsed(new JSONParser());
|
|
184
|
-
};
|
|
185
|
-
/**
|
|
186
|
-
* Sets the content of a file. Not supported for batching
|
|
187
|
-
*
|
|
188
|
-
* @param content The value to set for the file contents
|
|
189
|
-
*/
|
|
190
|
-
_Attachment.prototype.setContent = function (content) {
|
|
191
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
192
|
-
return __generator(this, function (_a) {
|
|
193
|
-
switch (_a.label) {
|
|
194
|
-
case 0: return [4 /*yield*/, spPost(this.clone(Attachment, "$value", false), headers({ "X-HTTP-Method": "PUT" }, {
|
|
195
|
-
body: content,
|
|
196
|
-
}))];
|
|
197
|
-
case 1:
|
|
198
|
-
_a.sent();
|
|
199
|
-
return [2 /*return*/, Attachment(this)];
|
|
200
|
-
}
|
|
201
|
-
});
|
|
202
|
-
});
|
|
203
|
-
};
|
|
204
|
-
/**
|
|
205
|
-
* Delete this attachment file and send it to recycle bin
|
|
206
|
-
*
|
|
207
|
-
* @param eTag Value used in the IF-Match header, by default "*"
|
|
208
|
-
*/
|
|
209
|
-
_Attachment.prototype.recycle = function (eTag) {
|
|
210
|
-
if (eTag === void 0) { eTag = "*"; }
|
|
211
|
-
return spPost(this.clone(Attachment, "recycleObject"), headers({
|
|
212
|
-
"IF-Match": eTag,
|
|
213
|
-
"X-HTTP-Method": "DELETE",
|
|
214
|
-
}));
|
|
215
|
-
};
|
|
216
|
-
_Attachment.prototype.getParsed = function (parser) {
|
|
217
|
-
return this.clone(Attachment, "$value", false).usingParser(parser)();
|
|
218
|
-
};
|
|
219
|
-
__decorate([
|
|
220
|
-
tag("at.getText")
|
|
221
|
-
], _Attachment.prototype, "getText", null);
|
|
222
|
-
__decorate([
|
|
223
|
-
tag("at.getBlob")
|
|
224
|
-
], _Attachment.prototype, "getBlob", null);
|
|
225
|
-
__decorate([
|
|
226
|
-
tag("at.getBuffer")
|
|
227
|
-
], _Attachment.prototype, "getBuffer", null);
|
|
228
|
-
__decorate([
|
|
229
|
-
tag("at.getJSON")
|
|
230
|
-
], _Attachment.prototype, "getJSON", null);
|
|
231
|
-
__decorate([
|
|
232
|
-
tag("at.setContent")
|
|
233
|
-
], _Attachment.prototype, "setContent", null);
|
|
234
|
-
__decorate([
|
|
235
|
-
tag("at.recycle")
|
|
236
|
-
], _Attachment.prototype, "recycle", null);
|
|
237
|
-
return _Attachment;
|
|
238
|
-
}(_SharePointQueryableInstance));
|
|
239
|
-
export { _Attachment };
|
|
240
|
-
export var Attachment = spInvokableFactory(_Attachment);
|
|
1
|
+
import { __awaiter, __decorate, __extends, __generator } from "tslib";
|
|
2
|
+
import { defaultPath } from "../decorators.js";
|
|
3
|
+
import { spPost } from "../operations.js";
|
|
4
|
+
import { _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, deleteableWithETag, } from "../sharepointqueryable.js";
|
|
5
|
+
import { TextParser, BlobParser, JSONParser, BufferParser, headers } from "@pnp/odata";
|
|
6
|
+
import { tag } from "../telemetry.js";
|
|
7
|
+
var _Attachments = /** @class */ (function (_super) {
|
|
8
|
+
__extends(_Attachments, _super);
|
|
9
|
+
function _Attachments() {
|
|
10
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Gets a Attachment File by filename
|
|
14
|
+
*
|
|
15
|
+
* @param name The name of the file, including extension.
|
|
16
|
+
*/
|
|
17
|
+
_Attachments.prototype.getByName = function (name) {
|
|
18
|
+
var f = tag.configure(Attachment(this), "ats.getByName");
|
|
19
|
+
f.concat("('" + name + "')");
|
|
20
|
+
return f;
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Adds a new attachment to the collection. Not supported for batching.
|
|
24
|
+
*
|
|
25
|
+
* @param name The name of the file, including extension.
|
|
26
|
+
* @param content The Base64 file content.
|
|
27
|
+
*/
|
|
28
|
+
_Attachments.prototype.add = function (name, content) {
|
|
29
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
30
|
+
var response;
|
|
31
|
+
return __generator(this, function (_a) {
|
|
32
|
+
switch (_a.label) {
|
|
33
|
+
case 0: return [4 /*yield*/, spPost(this.clone(Attachments, "add(FileName='" + name + "')", false), { body: content })];
|
|
34
|
+
case 1:
|
|
35
|
+
response = _a.sent();
|
|
36
|
+
return [2 /*return*/, {
|
|
37
|
+
data: response,
|
|
38
|
+
file: this.getByName(name),
|
|
39
|
+
}];
|
|
40
|
+
}
|
|
41
|
+
});
|
|
42
|
+
});
|
|
43
|
+
};
|
|
44
|
+
/**
|
|
45
|
+
* Adds multiple new attachment to the collection. Not supported for batching.
|
|
46
|
+
*
|
|
47
|
+
* @param files The collection of files to add
|
|
48
|
+
*/
|
|
49
|
+
_Attachments.prototype.addMultiple = function (files) {
|
|
50
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
51
|
+
var i;
|
|
52
|
+
return __generator(this, function (_a) {
|
|
53
|
+
switch (_a.label) {
|
|
54
|
+
case 0:
|
|
55
|
+
i = 0;
|
|
56
|
+
_a.label = 1;
|
|
57
|
+
case 1:
|
|
58
|
+
if (!(i < files.length)) return [3 /*break*/, 4];
|
|
59
|
+
return [4 /*yield*/, this.add(files[i].name, files[i].content)];
|
|
60
|
+
case 2:
|
|
61
|
+
_a.sent();
|
|
62
|
+
_a.label = 3;
|
|
63
|
+
case 3:
|
|
64
|
+
i++;
|
|
65
|
+
return [3 /*break*/, 1];
|
|
66
|
+
case 4: return [2 /*return*/];
|
|
67
|
+
}
|
|
68
|
+
});
|
|
69
|
+
});
|
|
70
|
+
};
|
|
71
|
+
/**
|
|
72
|
+
* Delete multiple attachments from the collection. Not supported for batching.
|
|
73
|
+
*
|
|
74
|
+
* @param files The collection of files to delete
|
|
75
|
+
*/
|
|
76
|
+
_Attachments.prototype.deleteMultiple = function () {
|
|
77
|
+
var files = [];
|
|
78
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
79
|
+
files[_i] = arguments[_i];
|
|
80
|
+
}
|
|
81
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
82
|
+
var i;
|
|
83
|
+
return __generator(this, function (_a) {
|
|
84
|
+
switch (_a.label) {
|
|
85
|
+
case 0:
|
|
86
|
+
i = 0;
|
|
87
|
+
_a.label = 1;
|
|
88
|
+
case 1:
|
|
89
|
+
if (!(i < files.length)) return [3 /*break*/, 4];
|
|
90
|
+
return [4 /*yield*/, this.getByName(files[i]).delete()];
|
|
91
|
+
case 2:
|
|
92
|
+
_a.sent();
|
|
93
|
+
_a.label = 3;
|
|
94
|
+
case 3:
|
|
95
|
+
i++;
|
|
96
|
+
return [3 /*break*/, 1];
|
|
97
|
+
case 4: return [2 /*return*/];
|
|
98
|
+
}
|
|
99
|
+
});
|
|
100
|
+
});
|
|
101
|
+
};
|
|
102
|
+
/**
|
|
103
|
+
* Delete multiple attachments from the collection and send to recycle bin. Not supported for batching.
|
|
104
|
+
*
|
|
105
|
+
* @param files The collection of files to be deleted and sent to recycle bin
|
|
106
|
+
*/
|
|
107
|
+
_Attachments.prototype.recycleMultiple = function () {
|
|
108
|
+
var files = [];
|
|
109
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
110
|
+
files[_i] = arguments[_i];
|
|
111
|
+
}
|
|
112
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
113
|
+
var i;
|
|
114
|
+
return __generator(this, function (_a) {
|
|
115
|
+
switch (_a.label) {
|
|
116
|
+
case 0:
|
|
117
|
+
i = 0;
|
|
118
|
+
_a.label = 1;
|
|
119
|
+
case 1:
|
|
120
|
+
if (!(i < files.length)) return [3 /*break*/, 4];
|
|
121
|
+
return [4 /*yield*/, this.getByName(files[i]).recycle()];
|
|
122
|
+
case 2:
|
|
123
|
+
_a.sent();
|
|
124
|
+
_a.label = 3;
|
|
125
|
+
case 3:
|
|
126
|
+
i++;
|
|
127
|
+
return [3 /*break*/, 1];
|
|
128
|
+
case 4: return [2 /*return*/];
|
|
129
|
+
}
|
|
130
|
+
});
|
|
131
|
+
});
|
|
132
|
+
};
|
|
133
|
+
__decorate([
|
|
134
|
+
tag("ats.add")
|
|
135
|
+
], _Attachments.prototype, "add", null);
|
|
136
|
+
__decorate([
|
|
137
|
+
tag("ats.addMultiple")
|
|
138
|
+
], _Attachments.prototype, "addMultiple", null);
|
|
139
|
+
__decorate([
|
|
140
|
+
tag("ats.deleteMultiple")
|
|
141
|
+
], _Attachments.prototype, "deleteMultiple", null);
|
|
142
|
+
__decorate([
|
|
143
|
+
tag("ats.recycleMultiple")
|
|
144
|
+
], _Attachments.prototype, "recycleMultiple", null);
|
|
145
|
+
_Attachments = __decorate([
|
|
146
|
+
defaultPath("AttachmentFiles")
|
|
147
|
+
], _Attachments);
|
|
148
|
+
return _Attachments;
|
|
149
|
+
}(_SharePointQueryableCollection));
|
|
150
|
+
export { _Attachments };
|
|
151
|
+
export var Attachments = spInvokableFactory(_Attachments);
|
|
152
|
+
var _Attachment = /** @class */ (function (_super) {
|
|
153
|
+
__extends(_Attachment, _super);
|
|
154
|
+
function _Attachment() {
|
|
155
|
+
var _this = _super !== null && _super.apply(this, arguments) || this;
|
|
156
|
+
_this.delete = deleteableWithETag("at");
|
|
157
|
+
return _this;
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* Gets the contents of the file as text
|
|
161
|
+
*
|
|
162
|
+
*/
|
|
163
|
+
_Attachment.prototype.getText = function () {
|
|
164
|
+
return this.getParsed(new TextParser());
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* Gets the contents of the file as a blob, does not work in Node.js
|
|
168
|
+
*
|
|
169
|
+
*/
|
|
170
|
+
_Attachment.prototype.getBlob = function () {
|
|
171
|
+
return this.getParsed(new BlobParser());
|
|
172
|
+
};
|
|
173
|
+
/**
|
|
174
|
+
* Gets the contents of a file as an ArrayBuffer, works in Node.js
|
|
175
|
+
*/
|
|
176
|
+
_Attachment.prototype.getBuffer = function () {
|
|
177
|
+
return this.getParsed(new BufferParser());
|
|
178
|
+
};
|
|
179
|
+
/**
|
|
180
|
+
* Gets the contents of a file as an ArrayBuffer, works in Node.js
|
|
181
|
+
*/
|
|
182
|
+
_Attachment.prototype.getJSON = function () {
|
|
183
|
+
return this.getParsed(new JSONParser());
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* Sets the content of a file. Not supported for batching
|
|
187
|
+
*
|
|
188
|
+
* @param content The value to set for the file contents
|
|
189
|
+
*/
|
|
190
|
+
_Attachment.prototype.setContent = function (content) {
|
|
191
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
192
|
+
return __generator(this, function (_a) {
|
|
193
|
+
switch (_a.label) {
|
|
194
|
+
case 0: return [4 /*yield*/, spPost(this.clone(Attachment, "$value", false), headers({ "X-HTTP-Method": "PUT" }, {
|
|
195
|
+
body: content,
|
|
196
|
+
}))];
|
|
197
|
+
case 1:
|
|
198
|
+
_a.sent();
|
|
199
|
+
return [2 /*return*/, Attachment(this)];
|
|
200
|
+
}
|
|
201
|
+
});
|
|
202
|
+
});
|
|
203
|
+
};
|
|
204
|
+
/**
|
|
205
|
+
* Delete this attachment file and send it to recycle bin
|
|
206
|
+
*
|
|
207
|
+
* @param eTag Value used in the IF-Match header, by default "*"
|
|
208
|
+
*/
|
|
209
|
+
_Attachment.prototype.recycle = function (eTag) {
|
|
210
|
+
if (eTag === void 0) { eTag = "*"; }
|
|
211
|
+
return spPost(this.clone(Attachment, "recycleObject"), headers({
|
|
212
|
+
"IF-Match": eTag,
|
|
213
|
+
"X-HTTP-Method": "DELETE",
|
|
214
|
+
}));
|
|
215
|
+
};
|
|
216
|
+
_Attachment.prototype.getParsed = function (parser) {
|
|
217
|
+
return this.clone(Attachment, "$value", false).usingParser(parser)();
|
|
218
|
+
};
|
|
219
|
+
__decorate([
|
|
220
|
+
tag("at.getText")
|
|
221
|
+
], _Attachment.prototype, "getText", null);
|
|
222
|
+
__decorate([
|
|
223
|
+
tag("at.getBlob")
|
|
224
|
+
], _Attachment.prototype, "getBlob", null);
|
|
225
|
+
__decorate([
|
|
226
|
+
tag("at.getBuffer")
|
|
227
|
+
], _Attachment.prototype, "getBuffer", null);
|
|
228
|
+
__decorate([
|
|
229
|
+
tag("at.getJSON")
|
|
230
|
+
], _Attachment.prototype, "getJSON", null);
|
|
231
|
+
__decorate([
|
|
232
|
+
tag("at.setContent")
|
|
233
|
+
], _Attachment.prototype, "setContent", null);
|
|
234
|
+
__decorate([
|
|
235
|
+
tag("at.recycle")
|
|
236
|
+
], _Attachment.prototype, "recycle", null);
|
|
237
|
+
return _Attachment;
|
|
238
|
+
}(_SharePointQueryableInstance));
|
|
239
|
+
export { _Attachment };
|
|
240
|
+
export var Attachment = spInvokableFactory(_Attachment);
|
|
241
241
|
//# sourceMappingURL=types.js.map
|
package/batch.d.ts
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
import { Batch } from "@pnp/odata";
|
|
2
|
-
import { Runtime } from "@pnp/common";
|
|
3
|
-
/**
|
|
4
|
-
* Manages a batch of OData operations
|
|
5
|
-
*/
|
|
6
|
-
export declare class SPBatch extends Batch {
|
|
7
|
-
private url;
|
|
8
|
-
private runtime;
|
|
9
|
-
constructor(url: string, runtime?: Runtime);
|
|
10
|
-
/**
|
|
11
|
-
* Parses the response from a batch request into an array of Response instances
|
|
12
|
-
*
|
|
13
|
-
* @param body Text body of the response from the batch request
|
|
14
|
-
*/
|
|
15
|
-
static ParseResponse(body: string): Response[];
|
|
16
|
-
protected executeImpl(): Promise<void>;
|
|
17
|
-
}
|
|
1
|
+
import { Batch } from "@pnp/odata";
|
|
2
|
+
import { Runtime } from "@pnp/common";
|
|
3
|
+
/**
|
|
4
|
+
* Manages a batch of OData operations
|
|
5
|
+
*/
|
|
6
|
+
export declare class SPBatch extends Batch {
|
|
7
|
+
private url;
|
|
8
|
+
private runtime;
|
|
9
|
+
constructor(url: string, runtime?: Runtime);
|
|
10
|
+
/**
|
|
11
|
+
* Parses the response from a batch request into an array of Response instances
|
|
12
|
+
*
|
|
13
|
+
* @param body Text body of the response from the batch request
|
|
14
|
+
*/
|
|
15
|
+
static ParseResponse(body: string): Response[];
|
|
16
|
+
protected executeImpl(): Promise<void>;
|
|
17
|
+
}
|
|
18
18
|
//# sourceMappingURL=batch.d.ts.map
|