@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.
- 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/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 -496
- package/clientside-pages/types.js +1496 -1496
- 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 -368
- package/fields/types.js +624 -624
- 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/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/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 -226
- package/items/types.js +549 -549
- 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/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/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.js +116 -116
- 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/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/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/LICENSE
CHANGED
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
SharePoint Patterns and Practices (PnP)
|
|
2
|
-
|
|
3
|
-
The MIT License (MIT)
|
|
4
|
-
|
|
5
|
-
Copyright (c) Microsoft Corporation
|
|
6
|
-
|
|
7
|
-
All rights reserved.
|
|
8
|
-
|
|
9
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
10
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
11
|
-
in the Software without restriction, including without limitation the rights
|
|
12
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
13
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
14
|
-
furnished to do so, subject to the following conditions:
|
|
15
|
-
|
|
16
|
-
The above copyright notice and this permission notice shall be included in all
|
|
17
|
-
copies or substantial portions of the Software.
|
|
18
|
-
|
|
19
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
20
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
21
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
22
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
23
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
24
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
25
|
-
SOFTWARE.
|
|
1
|
+
SharePoint Patterns and Practices (PnP)
|
|
2
|
+
|
|
3
|
+
The MIT License (MIT)
|
|
4
|
+
|
|
5
|
+
Copyright (c) Microsoft Corporation
|
|
6
|
+
|
|
7
|
+
All rights reserved.
|
|
8
|
+
|
|
9
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
10
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
11
|
+
in the Software without restriction, including without limitation the rights
|
|
12
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
13
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
14
|
+
furnished to do so, subject to the following conditions:
|
|
15
|
+
|
|
16
|
+
The above copyright notice and this permission notice shall be included in all
|
|
17
|
+
copies or substantial portions of the Software.
|
|
18
|
+
|
|
19
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
20
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
21
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
22
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
23
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
24
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
25
|
+
SOFTWARE.
|
package/appcatalog/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import { IWeb } from "../webs/types.js";
|
|
2
|
-
import "./web.js";
|
|
3
|
-
export { IAppAddResult, IApp, IAppCatalog, App, AppCatalog, } from "./types.js";
|
|
4
|
-
declare module "../rest" {
|
|
5
|
-
interface SPRest {
|
|
6
|
-
getTenantAppCatalogWeb(): Promise<IWeb>;
|
|
7
|
-
}
|
|
8
|
-
}
|
|
1
|
+
import { IWeb } from "../webs/types.js";
|
|
2
|
+
import "./web.js";
|
|
3
|
+
export { IAppAddResult, IApp, IAppCatalog, App, AppCatalog, } from "./types.js";
|
|
4
|
+
declare module "../rest" {
|
|
5
|
+
interface SPRest {
|
|
6
|
+
getTenantAppCatalogWeb(): Promise<IWeb>;
|
|
7
|
+
}
|
|
8
|
+
}
|
|
9
9
|
//# sourceMappingURL=index.d.ts.map
|
package/appcatalog/index.js
CHANGED
|
@@ -1,31 +1,31 @@
|
|
|
1
|
-
import { __awaiter, __generator } from "tslib";
|
|
2
|
-
import { SPRest } from "../rest.js";
|
|
3
|
-
import { Web } from "../webs/types.js";
|
|
4
|
-
import "./web.js";
|
|
5
|
-
import { SharePointQueryable } from "../sharepointqueryable.js";
|
|
6
|
-
export { App, AppCatalog, } from "./types.js";
|
|
7
|
-
SPRest.prototype.getTenantAppCatalogWeb = function () {
|
|
8
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
9
|
-
var _this = this;
|
|
10
|
-
return __generator(this, function (_a) {
|
|
11
|
-
return [2 /*return*/, this.childConfigHook(function (_a) {
|
|
12
|
-
var options = _a.options, runtime = _a.runtime;
|
|
13
|
-
return __awaiter(_this, void 0, void 0, function () {
|
|
14
|
-
var data;
|
|
15
|
-
return __generator(this, function (_b) {
|
|
16
|
-
switch (_b.label) {
|
|
17
|
-
case 0: return [4 /*yield*/, SharePointQueryable("/", "_api/SP_TenantSettings_Current").configure(options).setRuntime(runtime)()];
|
|
18
|
-
case 1:
|
|
19
|
-
data = _b.sent();
|
|
20
|
-
if (!(data === null || data === void 0 ? void 0 : data.CorporateCatalogUrl)) {
|
|
21
|
-
throw new Error("Failed to get tenant corporate app catalog, its not configured on the tenant.");
|
|
22
|
-
}
|
|
23
|
-
return [2 /*return*/, Web(data.CorporateCatalogUrl).configure(options).setRuntime(runtime)];
|
|
24
|
-
}
|
|
25
|
-
});
|
|
26
|
-
});
|
|
27
|
-
})];
|
|
28
|
-
});
|
|
29
|
-
});
|
|
30
|
-
};
|
|
1
|
+
import { __awaiter, __generator } from "tslib";
|
|
2
|
+
import { SPRest } from "../rest.js";
|
|
3
|
+
import { Web } from "../webs/types.js";
|
|
4
|
+
import "./web.js";
|
|
5
|
+
import { SharePointQueryable } from "../sharepointqueryable.js";
|
|
6
|
+
export { App, AppCatalog, } from "./types.js";
|
|
7
|
+
SPRest.prototype.getTenantAppCatalogWeb = function () {
|
|
8
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
9
|
+
var _this = this;
|
|
10
|
+
return __generator(this, function (_a) {
|
|
11
|
+
return [2 /*return*/, this.childConfigHook(function (_a) {
|
|
12
|
+
var options = _a.options, runtime = _a.runtime;
|
|
13
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
14
|
+
var data;
|
|
15
|
+
return __generator(this, function (_b) {
|
|
16
|
+
switch (_b.label) {
|
|
17
|
+
case 0: return [4 /*yield*/, SharePointQueryable("/", "_api/SP_TenantSettings_Current").configure(options).setRuntime(runtime)()];
|
|
18
|
+
case 1:
|
|
19
|
+
data = _b.sent();
|
|
20
|
+
if (!(data === null || data === void 0 ? void 0 : data.CorporateCatalogUrl)) {
|
|
21
|
+
throw new Error("Failed to get tenant corporate app catalog, its not configured on the tenant.");
|
|
22
|
+
}
|
|
23
|
+
return [2 /*return*/, Web(data.CorporateCatalogUrl).configure(options).setRuntime(runtime)];
|
|
24
|
+
}
|
|
25
|
+
});
|
|
26
|
+
});
|
|
27
|
+
})];
|
|
28
|
+
});
|
|
29
|
+
});
|
|
30
|
+
};
|
|
31
31
|
//# sourceMappingURL=index.js.map
|
package/appcatalog/types.d.ts
CHANGED
|
@@ -1,82 +1,82 @@
|
|
|
1
|
-
import { ISharePointQueryable, _SharePointQueryableInstance, _SharePointQueryableCollection } from "../sharepointqueryable";
|
|
2
|
-
import { IFile } from "../files/types.js";
|
|
3
|
-
import "../items/index.js";
|
|
4
|
-
export declare type AppCatalogScope = "tenant" | "sitecollection";
|
|
5
|
-
export declare class _AppCatalog extends _SharePointQueryableCollection {
|
|
6
|
-
private readonly catalogPath;
|
|
7
|
-
constructor(baseUrl: string | ISharePointQueryable, path?: string);
|
|
8
|
-
/**
|
|
9
|
-
* Get details of specific app from the app catalog
|
|
10
|
-
* @param id - Specify the guid of the app
|
|
11
|
-
*/
|
|
12
|
-
getAppById(id: string): IApp;
|
|
13
|
-
/**
|
|
14
|
-
* Synchronize a solution to the Microsoft Teams App Catalog
|
|
15
|
-
* @param id - Specify the guid of the app
|
|
16
|
-
* @param useSharePointItemId (optional) - By default this REST call requires the SP Item id of the app, not the app id.
|
|
17
|
-
* PnPjs will try to fetch the item id by default, you can still use this parameter to pass your own item id in the first parameter
|
|
18
|
-
*/
|
|
19
|
-
syncSolutionToTeams(id: string | number, useSharePointItemId?: boolean): Promise<void>;
|
|
20
|
-
/**
|
|
21
|
-
* Uploads an app package. Not supported for batching
|
|
22
|
-
*
|
|
23
|
-
* @param filename Filename to create.
|
|
24
|
-
* @param content app package data (eg: the .app or .sppkg file).
|
|
25
|
-
* @param shouldOverWrite Should an app with the same name in the same location be overwritten? (default: true)
|
|
26
|
-
* @returns Promise<IAppAddResult>
|
|
27
|
-
*/
|
|
28
|
-
add(filename: string, content: string | ArrayBuffer | Blob, shouldOverWrite?: boolean): Promise<IAppAddResult>;
|
|
29
|
-
}
|
|
30
|
-
export interface IAppCatalog extends _AppCatalog {
|
|
31
|
-
}
|
|
32
|
-
export declare const AppCatalog: import("../sharepointqueryable").ISPInvokableFactory<IAppCatalog>;
|
|
33
|
-
export declare class _App extends _SharePointQueryableInstance {
|
|
34
|
-
/**
|
|
35
|
-
* This method deploys an app on the app catalog. It must be called in the context
|
|
36
|
-
* of the tenant app catalog web or it will fail.
|
|
37
|
-
*
|
|
38
|
-
* @param skipFeatureDeployment Deploy the app to the entire tenant
|
|
39
|
-
*/
|
|
40
|
-
deploy(skipFeatureDeployment?: boolean): Promise<void>;
|
|
41
|
-
/**
|
|
42
|
-
* This method retracts a deployed app on the app catalog. It must be called in the context
|
|
43
|
-
* of the tenant app catalog web or it will fail.
|
|
44
|
-
*/
|
|
45
|
-
retract(): Promise<void>;
|
|
46
|
-
/**
|
|
47
|
-
* This method allows an app which is already deployed to be installed on a web
|
|
48
|
-
*/
|
|
49
|
-
install(): Promise<void>;
|
|
50
|
-
/**
|
|
51
|
-
* This method allows an app which is already installed to be uninstalled on a web
|
|
52
|
-
* Note: when you use the REST API to uninstall a solution package from the site, it is not relocated to the recycle bin
|
|
53
|
-
*/
|
|
54
|
-
uninstall(): Promise<void>;
|
|
55
|
-
/**
|
|
56
|
-
* This method allows an app which is already installed to be upgraded on a web
|
|
57
|
-
*/
|
|
58
|
-
upgrade(): Promise<void>;
|
|
59
|
-
/**
|
|
60
|
-
* This method removes an app from the app catalog. It must be called in the context
|
|
61
|
-
* of the tenant app catalog web or it will fail.
|
|
62
|
-
*/
|
|
63
|
-
remove(): Promise<void>;
|
|
64
|
-
private do;
|
|
65
|
-
}
|
|
66
|
-
export interface IApp extends _App {
|
|
67
|
-
}
|
|
68
|
-
export declare const App: import("../sharepointqueryable").ISPInvokableFactory<IApp>;
|
|
69
|
-
/**
|
|
70
|
-
* Result object after adding an app
|
|
71
|
-
*/
|
|
72
|
-
export interface IAppAddResult {
|
|
73
|
-
/**
|
|
74
|
-
* Contains metadata of the added app
|
|
75
|
-
*/
|
|
76
|
-
data: any;
|
|
77
|
-
/**
|
|
78
|
-
* A File instance to the item in SharePoint
|
|
79
|
-
*/
|
|
80
|
-
file: IFile;
|
|
81
|
-
}
|
|
1
|
+
import { ISharePointQueryable, _SharePointQueryableInstance, _SharePointQueryableCollection } from "../sharepointqueryable";
|
|
2
|
+
import { IFile } from "../files/types.js";
|
|
3
|
+
import "../items/index.js";
|
|
4
|
+
export declare type AppCatalogScope = "tenant" | "sitecollection";
|
|
5
|
+
export declare class _AppCatalog extends _SharePointQueryableCollection {
|
|
6
|
+
private readonly catalogPath;
|
|
7
|
+
constructor(baseUrl: string | ISharePointQueryable, path?: string);
|
|
8
|
+
/**
|
|
9
|
+
* Get details of specific app from the app catalog
|
|
10
|
+
* @param id - Specify the guid of the app
|
|
11
|
+
*/
|
|
12
|
+
getAppById(id: string): IApp;
|
|
13
|
+
/**
|
|
14
|
+
* Synchronize a solution to the Microsoft Teams App Catalog
|
|
15
|
+
* @param id - Specify the guid of the app
|
|
16
|
+
* @param useSharePointItemId (optional) - By default this REST call requires the SP Item id of the app, not the app id.
|
|
17
|
+
* PnPjs will try to fetch the item id by default, you can still use this parameter to pass your own item id in the first parameter
|
|
18
|
+
*/
|
|
19
|
+
syncSolutionToTeams(id: string | number, useSharePointItemId?: boolean): Promise<void>;
|
|
20
|
+
/**
|
|
21
|
+
* Uploads an app package. Not supported for batching
|
|
22
|
+
*
|
|
23
|
+
* @param filename Filename to create.
|
|
24
|
+
* @param content app package data (eg: the .app or .sppkg file).
|
|
25
|
+
* @param shouldOverWrite Should an app with the same name in the same location be overwritten? (default: true)
|
|
26
|
+
* @returns Promise<IAppAddResult>
|
|
27
|
+
*/
|
|
28
|
+
add(filename: string, content: string | ArrayBuffer | Blob, shouldOverWrite?: boolean): Promise<IAppAddResult>;
|
|
29
|
+
}
|
|
30
|
+
export interface IAppCatalog extends _AppCatalog {
|
|
31
|
+
}
|
|
32
|
+
export declare const AppCatalog: import("../sharepointqueryable").ISPInvokableFactory<IAppCatalog>;
|
|
33
|
+
export declare class _App extends _SharePointQueryableInstance {
|
|
34
|
+
/**
|
|
35
|
+
* This method deploys an app on the app catalog. It must be called in the context
|
|
36
|
+
* of the tenant app catalog web or it will fail.
|
|
37
|
+
*
|
|
38
|
+
* @param skipFeatureDeployment Deploy the app to the entire tenant
|
|
39
|
+
*/
|
|
40
|
+
deploy(skipFeatureDeployment?: boolean): Promise<void>;
|
|
41
|
+
/**
|
|
42
|
+
* This method retracts a deployed app on the app catalog. It must be called in the context
|
|
43
|
+
* of the tenant app catalog web or it will fail.
|
|
44
|
+
*/
|
|
45
|
+
retract(): Promise<void>;
|
|
46
|
+
/**
|
|
47
|
+
* This method allows an app which is already deployed to be installed on a web
|
|
48
|
+
*/
|
|
49
|
+
install(): Promise<void>;
|
|
50
|
+
/**
|
|
51
|
+
* This method allows an app which is already installed to be uninstalled on a web
|
|
52
|
+
* Note: when you use the REST API to uninstall a solution package from the site, it is not relocated to the recycle bin
|
|
53
|
+
*/
|
|
54
|
+
uninstall(): Promise<void>;
|
|
55
|
+
/**
|
|
56
|
+
* This method allows an app which is already installed to be upgraded on a web
|
|
57
|
+
*/
|
|
58
|
+
upgrade(): Promise<void>;
|
|
59
|
+
/**
|
|
60
|
+
* This method removes an app from the app catalog. It must be called in the context
|
|
61
|
+
* of the tenant app catalog web or it will fail.
|
|
62
|
+
*/
|
|
63
|
+
remove(): Promise<void>;
|
|
64
|
+
private do;
|
|
65
|
+
}
|
|
66
|
+
export interface IApp extends _App {
|
|
67
|
+
}
|
|
68
|
+
export declare const App: import("../sharepointqueryable").ISPInvokableFactory<IApp>;
|
|
69
|
+
/**
|
|
70
|
+
* Result object after adding an app
|
|
71
|
+
*/
|
|
72
|
+
export interface IAppAddResult {
|
|
73
|
+
/**
|
|
74
|
+
* Contains metadata of the added app
|
|
75
|
+
*/
|
|
76
|
+
data: any;
|
|
77
|
+
/**
|
|
78
|
+
* A File instance to the item in SharePoint
|
|
79
|
+
*/
|
|
80
|
+
file: IFile;
|
|
81
|
+
}
|
|
82
82
|
//# sourceMappingURL=types.d.ts.map
|
package/appcatalog/types.js
CHANGED
|
@@ -1,178 +1,178 @@
|
|
|
1
|
-
import { __awaiter, __decorate, __extends, __generator } from "tslib";
|
|
2
|
-
import { _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, } from "../sharepointqueryable";
|
|
3
|
-
import { spPost } from "../operations.js";
|
|
4
|
-
import { odataUrlFrom } from "../odata.js";
|
|
5
|
-
import { extractWebUrl } from "../utils/extractweburl.js";
|
|
6
|
-
import { File } from "../files/types.js";
|
|
7
|
-
import { tag } from "../telemetry.js";
|
|
8
|
-
import { Web } from "../webs/index.js";
|
|
9
|
-
import "../items/index.js";
|
|
10
|
-
var _AppCatalog = /** @class */ (function (_super) {
|
|
11
|
-
__extends(_AppCatalog, _super);
|
|
12
|
-
function _AppCatalog(baseUrl, path) {
|
|
13
|
-
var _this = _super.call(this, extractWebUrl(typeof baseUrl === "string" ? baseUrl : baseUrl.toUrl()), path) || this;
|
|
14
|
-
// get the catalog path without the AvailableApps suffix
|
|
15
|
-
// used for adding, syncing to teams
|
|
16
|
-
var pathSplit = path.split("/");
|
|
17
|
-
_this.catalogPath = pathSplit.slice(0, pathSplit.length - 1).join("/");
|
|
18
|
-
return _this;
|
|
19
|
-
}
|
|
20
|
-
/**
|
|
21
|
-
* Get details of specific app from the app catalog
|
|
22
|
-
* @param id - Specify the guid of the app
|
|
23
|
-
*/
|
|
24
|
-
_AppCatalog.prototype.getAppById = function (id) {
|
|
25
|
-
return tag.configure(App(this, "getById('" + id + "')").configureFrom(this), "ac.getAppById");
|
|
26
|
-
};
|
|
27
|
-
/**
|
|
28
|
-
* Synchronize a solution to the Microsoft Teams App Catalog
|
|
29
|
-
* @param id - Specify the guid of the app
|
|
30
|
-
* @param useSharePointItemId (optional) - By default this REST call requires the SP Item id of the app, not the app id.
|
|
31
|
-
* PnPjs will try to fetch the item id by default, you can still use this parameter to pass your own item id in the first parameter
|
|
32
|
-
*/
|
|
33
|
-
_AppCatalog.prototype.syncSolutionToTeams = function (id, useSharePointItemId) {
|
|
34
|
-
if (useSharePointItemId === void 0) { useSharePointItemId = false; }
|
|
35
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
36
|
-
var appId, webUrl, web, listId, listItems, poster;
|
|
37
|
-
return __generator(this, function (_a) {
|
|
38
|
-
switch (_a.label) {
|
|
39
|
-
case 0:
|
|
40
|
-
appId = null;
|
|
41
|
-
webUrl = extractWebUrl(this.toUrl());
|
|
42
|
-
if (!useSharePointItemId) return [3 /*break*/, 1];
|
|
43
|
-
appId = id;
|
|
44
|
-
return [3 /*break*/, 4];
|
|
45
|
-
case 1:
|
|
46
|
-
web = Web(webUrl).configureFrom(this);
|
|
47
|
-
return [4 /*yield*/, web.lists.select("Id").filter("EntityTypeName eq 'AppCatalog'")()];
|
|
48
|
-
case 2:
|
|
49
|
-
listId = (_a.sent())[0].Id;
|
|
50
|
-
return [4 /*yield*/, web.lists.getById(listId).items.filter("AppProductID eq '" + id + "'").top(1)()];
|
|
51
|
-
case 3:
|
|
52
|
-
listItems = _a.sent();
|
|
53
|
-
if (listItems && listItems.length > 0) {
|
|
54
|
-
appId = listItems[0].Id;
|
|
55
|
-
}
|
|
56
|
-
else {
|
|
57
|
-
throw Error("Did not find the app with id " + id + " in the appcatalog.");
|
|
58
|
-
}
|
|
59
|
-
_a.label = 4;
|
|
60
|
-
case 4:
|
|
61
|
-
poster = tag.configure(AppCatalog(webUrl, this.catalogPath + "/SyncSolutionToTeams(id=" + appId + ")"), "ac.syncSolutionToTeams");
|
|
62
|
-
poster.configureFrom(this);
|
|
63
|
-
return [4 /*yield*/, spPost(poster, {})];
|
|
64
|
-
case 5: return [2 /*return*/, _a.sent()];
|
|
65
|
-
}
|
|
66
|
-
});
|
|
67
|
-
});
|
|
68
|
-
};
|
|
69
|
-
/**
|
|
70
|
-
* Uploads an app package. Not supported for batching
|
|
71
|
-
*
|
|
72
|
-
* @param filename Filename to create.
|
|
73
|
-
* @param content app package data (eg: the .app or .sppkg file).
|
|
74
|
-
* @param shouldOverWrite Should an app with the same name in the same location be overwritten? (default: true)
|
|
75
|
-
* @returns Promise<IAppAddResult>
|
|
76
|
-
*/
|
|
77
|
-
_AppCatalog.prototype.add = function (filename, content, shouldOverWrite) {
|
|
78
|
-
if (shouldOverWrite === void 0) { shouldOverWrite = true; }
|
|
79
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
80
|
-
var adder, r;
|
|
81
|
-
return __generator(this, function (_a) {
|
|
82
|
-
switch (_a.label) {
|
|
83
|
-
case 0:
|
|
84
|
-
adder = tag.configure(AppCatalog(extractWebUrl(this.toUrl()), this.catalogPath + "/add(overwrite=" + shouldOverWrite + ",url='" + filename + "')"), "ac.add");
|
|
85
|
-
adder.configureFrom(this);
|
|
86
|
-
return [4 /*yield*/, spPost(adder, {
|
|
87
|
-
body: content, headers: {
|
|
88
|
-
"binaryStringRequestBody": "true",
|
|
89
|
-
},
|
|
90
|
-
})];
|
|
91
|
-
case 1:
|
|
92
|
-
r = _a.sent();
|
|
93
|
-
return [2 /*return*/, {
|
|
94
|
-
data: r,
|
|
95
|
-
file: File(odataUrlFrom(r)),
|
|
96
|
-
}];
|
|
97
|
-
}
|
|
98
|
-
});
|
|
99
|
-
});
|
|
100
|
-
};
|
|
101
|
-
return _AppCatalog;
|
|
102
|
-
}(_SharePointQueryableCollection));
|
|
103
|
-
export { _AppCatalog };
|
|
104
|
-
export var AppCatalog = spInvokableFactory(_AppCatalog);
|
|
105
|
-
var _App = /** @class */ (function (_super) {
|
|
106
|
-
__extends(_App, _super);
|
|
107
|
-
function _App() {
|
|
108
|
-
return _super !== null && _super.apply(this, arguments) || this;
|
|
109
|
-
}
|
|
110
|
-
/**
|
|
111
|
-
* This method deploys an app on the app catalog. It must be called in the context
|
|
112
|
-
* of the tenant app catalog web or it will fail.
|
|
113
|
-
*
|
|
114
|
-
* @param skipFeatureDeployment Deploy the app to the entire tenant
|
|
115
|
-
*/
|
|
116
|
-
_App.prototype.deploy = function (skipFeatureDeployment) {
|
|
117
|
-
if (skipFeatureDeployment === void 0) { skipFeatureDeployment = false; }
|
|
118
|
-
return this.do("Deploy(" + skipFeatureDeployment + ")");
|
|
119
|
-
};
|
|
120
|
-
/**
|
|
121
|
-
* This method retracts a deployed app on the app catalog. It must be called in the context
|
|
122
|
-
* of the tenant app catalog web or it will fail.
|
|
123
|
-
*/
|
|
124
|
-
_App.prototype.retract = function () {
|
|
125
|
-
return this.do("Retract");
|
|
126
|
-
};
|
|
127
|
-
/**
|
|
128
|
-
* This method allows an app which is already deployed to be installed on a web
|
|
129
|
-
*/
|
|
130
|
-
_App.prototype.install = function () {
|
|
131
|
-
return this.do("Install");
|
|
132
|
-
};
|
|
133
|
-
/**
|
|
134
|
-
* This method allows an app which is already installed to be uninstalled on a web
|
|
135
|
-
* Note: when you use the REST API to uninstall a solution package from the site, it is not relocated to the recycle bin
|
|
136
|
-
*/
|
|
137
|
-
_App.prototype.uninstall = function () {
|
|
138
|
-
return this.do("Uninstall");
|
|
139
|
-
};
|
|
140
|
-
/**
|
|
141
|
-
* This method allows an app which is already installed to be upgraded on a web
|
|
142
|
-
*/
|
|
143
|
-
_App.prototype.upgrade = function () {
|
|
144
|
-
return this.do("Upgrade");
|
|
145
|
-
};
|
|
146
|
-
/**
|
|
147
|
-
* This method removes an app from the app catalog. It must be called in the context
|
|
148
|
-
* of the tenant app catalog web or it will fail.
|
|
149
|
-
*/
|
|
150
|
-
_App.prototype.remove = function () {
|
|
151
|
-
return this.do("Remove");
|
|
152
|
-
};
|
|
153
|
-
_App.prototype.do = function (path) {
|
|
154
|
-
return spPost(this.clone(App, path));
|
|
155
|
-
};
|
|
156
|
-
__decorate([
|
|
157
|
-
tag("app.deploy")
|
|
158
|
-
], _App.prototype, "deploy", null);
|
|
159
|
-
__decorate([
|
|
160
|
-
tag("app.retract")
|
|
161
|
-
], _App.prototype, "retract", null);
|
|
162
|
-
__decorate([
|
|
163
|
-
tag("app.install")
|
|
164
|
-
], _App.prototype, "install", null);
|
|
165
|
-
__decorate([
|
|
166
|
-
tag("app.uninstall")
|
|
167
|
-
], _App.prototype, "uninstall", null);
|
|
168
|
-
__decorate([
|
|
169
|
-
tag("app.upgrade")
|
|
170
|
-
], _App.prototype, "upgrade", null);
|
|
171
|
-
__decorate([
|
|
172
|
-
tag("app.remove")
|
|
173
|
-
], _App.prototype, "remove", null);
|
|
174
|
-
return _App;
|
|
175
|
-
}(_SharePointQueryableInstance));
|
|
176
|
-
export { _App };
|
|
177
|
-
export var App = spInvokableFactory(_App);
|
|
1
|
+
import { __awaiter, __decorate, __extends, __generator } from "tslib";
|
|
2
|
+
import { _SharePointQueryableInstance, _SharePointQueryableCollection, spInvokableFactory, } from "../sharepointqueryable";
|
|
3
|
+
import { spPost } from "../operations.js";
|
|
4
|
+
import { odataUrlFrom } from "../odata.js";
|
|
5
|
+
import { extractWebUrl } from "../utils/extractweburl.js";
|
|
6
|
+
import { File } from "../files/types.js";
|
|
7
|
+
import { tag } from "../telemetry.js";
|
|
8
|
+
import { Web } from "../webs/index.js";
|
|
9
|
+
import "../items/index.js";
|
|
10
|
+
var _AppCatalog = /** @class */ (function (_super) {
|
|
11
|
+
__extends(_AppCatalog, _super);
|
|
12
|
+
function _AppCatalog(baseUrl, path) {
|
|
13
|
+
var _this = _super.call(this, extractWebUrl(typeof baseUrl === "string" ? baseUrl : baseUrl.toUrl()), path) || this;
|
|
14
|
+
// get the catalog path without the AvailableApps suffix
|
|
15
|
+
// used for adding, syncing to teams
|
|
16
|
+
var pathSplit = path.split("/");
|
|
17
|
+
_this.catalogPath = pathSplit.slice(0, pathSplit.length - 1).join("/");
|
|
18
|
+
return _this;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Get details of specific app from the app catalog
|
|
22
|
+
* @param id - Specify the guid of the app
|
|
23
|
+
*/
|
|
24
|
+
_AppCatalog.prototype.getAppById = function (id) {
|
|
25
|
+
return tag.configure(App(this, "getById('" + id + "')").configureFrom(this), "ac.getAppById");
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* Synchronize a solution to the Microsoft Teams App Catalog
|
|
29
|
+
* @param id - Specify the guid of the app
|
|
30
|
+
* @param useSharePointItemId (optional) - By default this REST call requires the SP Item id of the app, not the app id.
|
|
31
|
+
* PnPjs will try to fetch the item id by default, you can still use this parameter to pass your own item id in the first parameter
|
|
32
|
+
*/
|
|
33
|
+
_AppCatalog.prototype.syncSolutionToTeams = function (id, useSharePointItemId) {
|
|
34
|
+
if (useSharePointItemId === void 0) { useSharePointItemId = false; }
|
|
35
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
36
|
+
var appId, webUrl, web, listId, listItems, poster;
|
|
37
|
+
return __generator(this, function (_a) {
|
|
38
|
+
switch (_a.label) {
|
|
39
|
+
case 0:
|
|
40
|
+
appId = null;
|
|
41
|
+
webUrl = extractWebUrl(this.toUrl());
|
|
42
|
+
if (!useSharePointItemId) return [3 /*break*/, 1];
|
|
43
|
+
appId = id;
|
|
44
|
+
return [3 /*break*/, 4];
|
|
45
|
+
case 1:
|
|
46
|
+
web = Web(webUrl).configureFrom(this);
|
|
47
|
+
return [4 /*yield*/, web.lists.select("Id").filter("EntityTypeName eq 'AppCatalog'")()];
|
|
48
|
+
case 2:
|
|
49
|
+
listId = (_a.sent())[0].Id;
|
|
50
|
+
return [4 /*yield*/, web.lists.getById(listId).items.filter("AppProductID eq '" + id + "'").top(1)()];
|
|
51
|
+
case 3:
|
|
52
|
+
listItems = _a.sent();
|
|
53
|
+
if (listItems && listItems.length > 0) {
|
|
54
|
+
appId = listItems[0].Id;
|
|
55
|
+
}
|
|
56
|
+
else {
|
|
57
|
+
throw Error("Did not find the app with id " + id + " in the appcatalog.");
|
|
58
|
+
}
|
|
59
|
+
_a.label = 4;
|
|
60
|
+
case 4:
|
|
61
|
+
poster = tag.configure(AppCatalog(webUrl, this.catalogPath + "/SyncSolutionToTeams(id=" + appId + ")"), "ac.syncSolutionToTeams");
|
|
62
|
+
poster.configureFrom(this);
|
|
63
|
+
return [4 /*yield*/, spPost(poster, {})];
|
|
64
|
+
case 5: return [2 /*return*/, _a.sent()];
|
|
65
|
+
}
|
|
66
|
+
});
|
|
67
|
+
});
|
|
68
|
+
};
|
|
69
|
+
/**
|
|
70
|
+
* Uploads an app package. Not supported for batching
|
|
71
|
+
*
|
|
72
|
+
* @param filename Filename to create.
|
|
73
|
+
* @param content app package data (eg: the .app or .sppkg file).
|
|
74
|
+
* @param shouldOverWrite Should an app with the same name in the same location be overwritten? (default: true)
|
|
75
|
+
* @returns Promise<IAppAddResult>
|
|
76
|
+
*/
|
|
77
|
+
_AppCatalog.prototype.add = function (filename, content, shouldOverWrite) {
|
|
78
|
+
if (shouldOverWrite === void 0) { shouldOverWrite = true; }
|
|
79
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
80
|
+
var adder, r;
|
|
81
|
+
return __generator(this, function (_a) {
|
|
82
|
+
switch (_a.label) {
|
|
83
|
+
case 0:
|
|
84
|
+
adder = tag.configure(AppCatalog(extractWebUrl(this.toUrl()), this.catalogPath + "/add(overwrite=" + shouldOverWrite + ",url='" + filename + "')"), "ac.add");
|
|
85
|
+
adder.configureFrom(this);
|
|
86
|
+
return [4 /*yield*/, spPost(adder, {
|
|
87
|
+
body: content, headers: {
|
|
88
|
+
"binaryStringRequestBody": "true",
|
|
89
|
+
},
|
|
90
|
+
})];
|
|
91
|
+
case 1:
|
|
92
|
+
r = _a.sent();
|
|
93
|
+
return [2 /*return*/, {
|
|
94
|
+
data: r,
|
|
95
|
+
file: File(odataUrlFrom(r)),
|
|
96
|
+
}];
|
|
97
|
+
}
|
|
98
|
+
});
|
|
99
|
+
});
|
|
100
|
+
};
|
|
101
|
+
return _AppCatalog;
|
|
102
|
+
}(_SharePointQueryableCollection));
|
|
103
|
+
export { _AppCatalog };
|
|
104
|
+
export var AppCatalog = spInvokableFactory(_AppCatalog);
|
|
105
|
+
var _App = /** @class */ (function (_super) {
|
|
106
|
+
__extends(_App, _super);
|
|
107
|
+
function _App() {
|
|
108
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* This method deploys an app on the app catalog. It must be called in the context
|
|
112
|
+
* of the tenant app catalog web or it will fail.
|
|
113
|
+
*
|
|
114
|
+
* @param skipFeatureDeployment Deploy the app to the entire tenant
|
|
115
|
+
*/
|
|
116
|
+
_App.prototype.deploy = function (skipFeatureDeployment) {
|
|
117
|
+
if (skipFeatureDeployment === void 0) { skipFeatureDeployment = false; }
|
|
118
|
+
return this.do("Deploy(" + skipFeatureDeployment + ")");
|
|
119
|
+
};
|
|
120
|
+
/**
|
|
121
|
+
* This method retracts a deployed app on the app catalog. It must be called in the context
|
|
122
|
+
* of the tenant app catalog web or it will fail.
|
|
123
|
+
*/
|
|
124
|
+
_App.prototype.retract = function () {
|
|
125
|
+
return this.do("Retract");
|
|
126
|
+
};
|
|
127
|
+
/**
|
|
128
|
+
* This method allows an app which is already deployed to be installed on a web
|
|
129
|
+
*/
|
|
130
|
+
_App.prototype.install = function () {
|
|
131
|
+
return this.do("Install");
|
|
132
|
+
};
|
|
133
|
+
/**
|
|
134
|
+
* This method allows an app which is already installed to be uninstalled on a web
|
|
135
|
+
* Note: when you use the REST API to uninstall a solution package from the site, it is not relocated to the recycle bin
|
|
136
|
+
*/
|
|
137
|
+
_App.prototype.uninstall = function () {
|
|
138
|
+
return this.do("Uninstall");
|
|
139
|
+
};
|
|
140
|
+
/**
|
|
141
|
+
* This method allows an app which is already installed to be upgraded on a web
|
|
142
|
+
*/
|
|
143
|
+
_App.prototype.upgrade = function () {
|
|
144
|
+
return this.do("Upgrade");
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* This method removes an app from the app catalog. It must be called in the context
|
|
148
|
+
* of the tenant app catalog web or it will fail.
|
|
149
|
+
*/
|
|
150
|
+
_App.prototype.remove = function () {
|
|
151
|
+
return this.do("Remove");
|
|
152
|
+
};
|
|
153
|
+
_App.prototype.do = function (path) {
|
|
154
|
+
return spPost(this.clone(App, path));
|
|
155
|
+
};
|
|
156
|
+
__decorate([
|
|
157
|
+
tag("app.deploy")
|
|
158
|
+
], _App.prototype, "deploy", null);
|
|
159
|
+
__decorate([
|
|
160
|
+
tag("app.retract")
|
|
161
|
+
], _App.prototype, "retract", null);
|
|
162
|
+
__decorate([
|
|
163
|
+
tag("app.install")
|
|
164
|
+
], _App.prototype, "install", null);
|
|
165
|
+
__decorate([
|
|
166
|
+
tag("app.uninstall")
|
|
167
|
+
], _App.prototype, "uninstall", null);
|
|
168
|
+
__decorate([
|
|
169
|
+
tag("app.upgrade")
|
|
170
|
+
], _App.prototype, "upgrade", null);
|
|
171
|
+
__decorate([
|
|
172
|
+
tag("app.remove")
|
|
173
|
+
], _App.prototype, "remove", null);
|
|
174
|
+
return _App;
|
|
175
|
+
}(_SharePointQueryableInstance));
|
|
176
|
+
export { _App };
|
|
177
|
+
export var App = spInvokableFactory(_App);
|
|
178
178
|
//# sourceMappingURL=types.js.map
|