@agility/management-sdk 0.1.3 → 0.1.4-beta.1
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/.cursor/api-documentation-manifest.md +275 -0
- package/.cursor/api-functions-analysis.md +111 -0
- package/.cursor/docs-final-check.md +269 -0
- package/.cursor/manifest.md +153 -0
- package/.env +92 -0
- package/README.md +219 -352
- package/dist/apiClient.d.ts +86 -0
- package/dist/apiClient.js +229 -0
- package/dist/apiClient.js.map +1 -0
- package/dist/apiMethods/assetMethods.d.ts +28 -6
- package/dist/apiMethods/assetMethods.js +224 -29
- package/dist/apiMethods/assetMethods.js.map +1 -0
- package/dist/apiMethods/authMethods.d.ts +239 -0
- package/dist/apiMethods/authMethods.js +604 -0
- package/dist/apiMethods/batchMethods.d.ts +32 -1
- package/dist/apiMethods/batchMethods.js +241 -11
- package/dist/apiMethods/batchMethods.js.map +1 -0
- package/dist/apiMethods/clientInstance.d.ts +58 -4
- package/dist/apiMethods/clientInstance.js +311 -44
- package/dist/apiMethods/clientInstance.js.map +1 -0
- package/dist/apiMethods/containerMethods.d.ts +15 -7
- package/dist/apiMethods/containerMethods.js +70 -38
- package/dist/apiMethods/containerMethods.js.map +1 -0
- package/dist/apiMethods/contentMethods.d.ts +17 -10
- package/dist/apiMethods/contentMethods.js +169 -70
- package/dist/apiMethods/contentMethods.js.map +1 -0
- package/dist/apiMethods/instanceMethods.d.ts +9 -0
- package/dist/apiMethods/instanceMethods.js +69 -0
- package/dist/apiMethods/instanceMethods.js.map +1 -0
- package/dist/apiMethods/instanceUserMethods.d.ts +3 -3
- package/dist/apiMethods/instanceUserMethods.js +18 -18
- package/dist/apiMethods/instanceUserMethods.js.map +1 -0
- package/dist/apiMethods/modelMethods.d.ts +6 -5
- package/dist/apiMethods/modelMethods.js +46 -26
- package/dist/apiMethods/modelMethods.js.map +1 -0
- package/dist/apiMethods/pageMethods.d.ts +21 -9
- package/dist/apiMethods/pageMethods.js +278 -76
- package/dist/apiMethods/pageMethods.js.map +1 -0
- package/dist/apiMethods/serverUserMethods.d.ts +10 -0
- package/dist/apiMethods/serverUserMethods.js +89 -0
- package/dist/apiMethods/serverUserMethods.js.map +1 -0
- package/dist/apiMethods/webhookMethods.d.ts +12 -0
- package/dist/apiMethods/webhookMethods.js +131 -0
- package/dist/apiMethods/webhookMethods.js.map +1 -0
- package/dist/enums/assetGroupingType.d.ts +3 -0
- package/dist/enums/assetGroupingType.js +7 -0
- package/dist/enums/assetGroupingType.js.map +1 -0
- package/dist/enums/batchItemType.d.ts +7 -0
- package/dist/enums/batchItemType.js +11 -0
- package/dist/enums/batchOperationType.js +1 -1
- package/dist/enums/batchOperationType.js.map +1 -0
- package/dist/enums/batchState..js +1 -1
- package/dist/enums/batchState.d.ts +7 -0
- package/dist/enums/batchState.js +12 -0
- package/dist/enums/batchState.js.map +1 -0
- package/dist/enums/pageItemTemplateType.d.ts +4 -0
- package/dist/enums/pageItemTemplateType.js +8 -0
- package/dist/enums/pageItemTemplateType.js.map +1 -0
- package/dist/enums/workflowOperationType.d.ts +26 -0
- package/dist/enums/workflowOperationType.js +30 -0
- package/dist/errors/exception.d.ts +4 -0
- package/dist/errors/exception.js +11 -0
- package/dist/errors/exception.js.map +1 -0
- package/dist/index.d.ts +41 -9
- package/dist/index.js +48 -10
- package/dist/index.js.map +1 -0
- package/dist/models/assetContainer.d.ts +7 -0
- package/dist/models/assetContainer.js +9 -0
- package/dist/models/assetGalleries.d.ts +5 -0
- package/dist/models/assetGalleries.js +9 -0
- package/dist/models/assetMediaGrouping.d.ts +17 -0
- package/dist/models/assetMediaGrouping.js +9 -0
- package/dist/models/assetMediaGroupingMetaData.d.ts +4 -0
- package/dist/models/assetMediaGroupingMetaData.js +9 -0
- package/dist/models/authTokens.d.ts +73 -0
- package/dist/models/authTokens.js +2 -0
- package/dist/models/batchItem.d.ts +1 -0
- package/dist/models/batchRequests.d.ts +67 -0
- package/dist/models/batchRequests.js +2 -0
- package/dist/models/batchTypes.d.ts +34 -0
- package/dist/models/batchTypes.js +2 -0
- package/dist/models/container.d.ts +2 -1
- package/dist/models/contentDefinitionTypeID.d.ts +17 -0
- package/dist/models/contentDefinitionTypeID.js +21 -0
- package/dist/models/contentItemHistory.d.ts +20 -0
- package/dist/models/contentItemHistory.js +15 -0
- package/dist/models/contentListFilterModel.d.ts +26 -0
- package/dist/models/contentListFilterModel.js +33 -0
- package/dist/models/contentSectionDefaultModule.d.ts +7 -0
- package/dist/models/contentSectionDefaultModule.js +9 -0
- package/dist/models/contentSectionDefinition.d.ts +35 -0
- package/dist/models/contentSectionDefinition.js +9 -0
- package/dist/models/exception.js +2 -0
- package/dist/models/itemComments.d.ts +14 -0
- package/dist/models/itemComments.js +15 -0
- package/dist/models/listParams.d.ts +9 -0
- package/dist/models/listParams.js +16 -0
- package/dist/models/locales.d.ts +3 -0
- package/dist/models/locales.js +30 -0
- package/dist/models/options.d.ts +2 -5
- package/dist/models/options.js +0 -19
- package/dist/models/pageHistory.d.ts +21 -0
- package/dist/models/pageHistory.js +15 -0
- package/dist/models/pageModel.d.ts +14 -0
- package/dist/models/pageModel.js +9 -0
- package/dist/models/serverUser.d.ts +21 -0
- package/dist/models/serverUser.js +9 -0
- package/dist/models/sharedModule.d.ts +7 -0
- package/dist/models/sharedModule.js +9 -0
- package/dist/models/webhook.d.ts +9 -0
- package/dist/models/webhook.js +9 -0
- package/dist/models/websiteListing.d.ts +16 -0
- package/dist/models/websiteListing.js +9 -0
- package/dist/tests/authHelper.d.ts +2 -0
- package/dist/tests/authHelper.js +14 -0
- package/dist/tests/authHelper.js.map +1 -0
- package/dist/tests/config/apiClient.config.d.ts +16 -0
- package/dist/tests/config/apiClient.config.js +84 -0
- package/dist/tests/config/apiClient.config.js.map +1 -0
- package/dist/tests/config/test.config.d.ts +24 -0
- package/dist/tests/config/test.config.js +47 -0
- package/dist/tests/config/test.config.js.map +1 -0
- package/dist/tokenStorage.d.ts +72 -0
- package/dist/tokenStorage.js +366 -0
- package/dist/types/apiResponse.d.ts +13 -0
- package/dist/types/apiResponse.js +3 -0
- package/dist/types/apiResponse.js.map +1 -0
- package/dist/types/assetContainer.d.ts +7 -0
- package/dist/types/assetContainer.js +3 -0
- package/dist/types/assetContainer.js.map +1 -0
- package/dist/types/assetGalleries.d.ts +5 -0
- package/dist/types/assetGalleries.js +3 -0
- package/dist/types/assetGalleries.js.map +1 -0
- package/dist/types/assetMediaGrouping.d.ts +17 -0
- package/dist/types/assetMediaGrouping.js +3 -0
- package/dist/types/assetMediaGrouping.js.map +1 -0
- package/dist/types/assetMediaGroupingMetaData.d.ts +4 -0
- package/dist/types/assetMediaGroupingMetaData.js +3 -0
- package/dist/types/assetMediaGroupingMetaData.js.map +1 -0
- package/dist/types/batch.d.ts +29 -0
- package/dist/types/batch.js +3 -0
- package/dist/types/batch.js.map +1 -0
- package/dist/types/batchItem.d.ts +13 -0
- package/dist/types/batchItem.js +3 -0
- package/dist/types/batchItem.js.map +1 -0
- package/dist/types/container.d.ts +47 -0
- package/dist/types/container.js +3 -0
- package/dist/types/container.js.map +1 -0
- package/dist/types/contentItem.d.ts +37 -0
- package/dist/types/contentItem.js +3 -0
- package/dist/types/contentItem.js.map +1 -0
- package/dist/types/contentItemHistory.d.ts +20 -0
- package/dist/types/contentItemHistory.js +3 -0
- package/dist/types/contentItemHistory.js.map +1 -0
- package/dist/types/contentListFilterModel.d.ts +26 -0
- package/dist/types/contentListFilterModel.js +3 -0
- package/dist/types/contentListFilterModel.js.map +1 -0
- package/dist/types/contentSectionDefaultModule.d.ts +7 -0
- package/dist/types/contentSectionDefaultModule.js +3 -0
- package/dist/types/contentSectionDefaultModule.js.map +1 -0
- package/dist/types/contentSectionDefinition.d.ts +35 -0
- package/dist/types/contentSectionDefinition.js +3 -0
- package/dist/types/contentSectionDefinition.js.map +1 -0
- package/dist/types/contentViewColumn.d.ts +8 -0
- package/dist/types/contentViewColumn.js +3 -0
- package/dist/types/contentViewColumn.js.map +1 -0
- package/dist/types/instanceRole.d.ts +7 -0
- package/dist/types/instanceRole.js +3 -0
- package/dist/types/instanceRole.js.map +1 -0
- package/dist/types/instanceUser.d.ts +14 -0
- package/dist/types/instanceUser.js +3 -0
- package/dist/types/instanceUser.js.map +1 -0
- package/dist/types/itemComments.d.ts +14 -0
- package/dist/types/itemComments.js +3 -0
- package/dist/types/itemComments.js.map +1 -0
- package/dist/types/listParams.d.ts +9 -0
- package/dist/types/listParams.js +3 -0
- package/dist/types/listParams.js.map +1 -0
- package/dist/types/locales.d.ts +1 -0
- package/dist/types/locales.js +3 -0
- package/dist/types/locales.js.map +1 -0
- package/dist/types/media.d.ts +30 -0
- package/dist/types/media.js +3 -0
- package/dist/types/media.js.map +1 -0
- package/dist/types/model.d.ts +30 -0
- package/dist/types/model.js +3 -0
- package/dist/types/model.js.map +1 -0
- package/dist/types/notification.d.ts +13 -0
- package/dist/types/notification.js +3 -0
- package/dist/types/notification.js.map +1 -0
- package/dist/types/options.d.ts +7 -0
- package/dist/types/options.js +3 -0
- package/dist/types/options.js.map +1 -0
- package/dist/types/pageHistory.d.ts +21 -0
- package/dist/types/pageHistory.js +3 -0
- package/dist/types/pageHistory.js.map +1 -0
- package/dist/types/pageItem.d.ts +56 -0
- package/dist/types/pageItem.js +3 -0
- package/dist/types/pageItem.js.map +1 -0
- package/dist/types/pageModel.d.ts +14 -0
- package/dist/types/pageModel.js +3 -0
- package/dist/types/pageModel.js.map +1 -0
- package/dist/types/serverUser.d.ts +21 -0
- package/dist/types/serverUser.js +3 -0
- package/dist/types/serverUser.js.map +1 -0
- package/dist/types/sharedModule.d.ts +7 -0
- package/dist/types/sharedModule.js +3 -0
- package/dist/types/sharedModule.js.map +1 -0
- package/dist/types/sitemap.d.ts +20 -0
- package/dist/types/sitemap.js +3 -0
- package/dist/types/sitemap.js.map +1 -0
- package/dist/types/tokenResponseData.d.ts +10 -0
- package/dist/types/tokenResponseData.js +3 -0
- package/dist/types/tokenResponseData.js.map +1 -0
- package/dist/types/webhook.d.ts +9 -0
- package/dist/types/webhook.js +3 -0
- package/dist/types/webhook.js.map +1 -0
- package/dist/types/websiteListing.d.ts +16 -0
- package/dist/types/websiteListing.js +3 -0
- package/dist/types/websiteListing.js.map +1 -0
- package/dist/types/websiteUser.d.ts +22 -0
- package/dist/types/websiteUser.js +3 -0
- package/dist/types/websiteUser.js.map +1 -0
- package/docs/asset-methods.md +382 -0
- package/docs/auth.md +594 -0
- package/docs/batch-methods.md +244 -0
- package/docs/cicd.md +607 -0
- package/docs/container-methods.md +268 -0
- package/docs/content-methods.md +423 -0
- package/docs/instance-methods.md +105 -0
- package/docs/instance-user-methods.md +231 -0
- package/docs/model-methods.md +434 -0
- package/docs/multi-instance-operations.md +192 -0
- package/docs/page-methods.md +671 -0
- package/docs/server-user-methods.md +280 -0
- package/docs/webhook-methods.md +452 -0
- package/package.json +14 -10
- package/tsconfig.json +1 -1
|
@@ -9,12 +9,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
9
9
|
});
|
|
10
10
|
};
|
|
11
11
|
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
12
|
-
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
13
|
-
return g =
|
|
12
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
|
|
13
|
+
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
14
14
|
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
15
15
|
function step(op) {
|
|
16
16
|
if (f) throw new TypeError("Generator is already executing.");
|
|
17
|
-
while (_) try {
|
|
17
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
18
18
|
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
19
19
|
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
20
20
|
switch (op[0]) {
|
|
@@ -42,30 +42,30 @@ var exception_1 = require("../models/exception");
|
|
|
42
42
|
var AssetMethods = /** @class */ (function () {
|
|
43
43
|
function AssetMethods(options) {
|
|
44
44
|
this._options = options;
|
|
45
|
-
this._clientInstance = new clientInstance_1.ClientInstance();
|
|
45
|
+
this._clientInstance = new clientInstance_1.ClientInstance(this._options);
|
|
46
46
|
}
|
|
47
|
-
AssetMethods.prototype.deleteFile = function (mediaID) {
|
|
47
|
+
AssetMethods.prototype.deleteFile = function (mediaID, guid) {
|
|
48
48
|
return __awaiter(this, void 0, void 0, function () {
|
|
49
49
|
var apiPath, resp, err_1;
|
|
50
50
|
return __generator(this, function (_a) {
|
|
51
51
|
switch (_a.label) {
|
|
52
52
|
case 0:
|
|
53
53
|
_a.trys.push([0, 2, , 3]);
|
|
54
|
-
apiPath = "asset/delete/"
|
|
55
|
-
return [4 /*yield*/, this._clientInstance.executeDelete(apiPath, this._options)];
|
|
54
|
+
apiPath = "asset/delete/".concat(mediaID);
|
|
55
|
+
return [4 /*yield*/, this._clientInstance.executeDelete(apiPath, guid, this._options.token)];
|
|
56
56
|
case 1:
|
|
57
57
|
resp = _a.sent();
|
|
58
58
|
;
|
|
59
59
|
return [2 /*return*/, resp.data];
|
|
60
60
|
case 2:
|
|
61
61
|
err_1 = _a.sent();
|
|
62
|
-
throw new exception_1.Exception("Unable to delete the media for mediaID: "
|
|
62
|
+
throw new exception_1.Exception("Unable to delete the media for mediaID: ".concat(mediaID), err_1);
|
|
63
63
|
case 3: return [2 /*return*/];
|
|
64
64
|
}
|
|
65
65
|
});
|
|
66
66
|
});
|
|
67
67
|
};
|
|
68
|
-
AssetMethods.prototype.moveFile = function (mediaID, newFolder) {
|
|
68
|
+
AssetMethods.prototype.moveFile = function (mediaID, newFolder, guid) {
|
|
69
69
|
return __awaiter(this, void 0, void 0, function () {
|
|
70
70
|
var folder, apiPath, resp, err_2;
|
|
71
71
|
return __generator(this, function (_a) {
|
|
@@ -73,28 +73,28 @@ var AssetMethods = /** @class */ (function () {
|
|
|
73
73
|
case 0:
|
|
74
74
|
_a.trys.push([0, 2, , 3]);
|
|
75
75
|
folder = encodeURIComponent(newFolder);
|
|
76
|
-
apiPath = "asset/move/"
|
|
77
|
-
return [4 /*yield*/, this._clientInstance.executePost(apiPath, this._options, null)];
|
|
76
|
+
apiPath = "asset/move/".concat(mediaID, "?newFolder=").concat(folder);
|
|
77
|
+
return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, null)];
|
|
78
78
|
case 1:
|
|
79
79
|
resp = _a.sent();
|
|
80
80
|
return [2 /*return*/, resp.data];
|
|
81
81
|
case 2:
|
|
82
82
|
err_2 = _a.sent();
|
|
83
|
-
throw new exception_1.Exception("Unable to move the media for mediaID: "
|
|
83
|
+
throw new exception_1.Exception("Unable to move the media for mediaID: ".concat(mediaID), err_2);
|
|
84
84
|
case 3: return [2 /*return*/];
|
|
85
85
|
}
|
|
86
86
|
});
|
|
87
87
|
});
|
|
88
88
|
};
|
|
89
|
-
AssetMethods.prototype.getMediaList = function (pageSize, recordOffset) {
|
|
89
|
+
AssetMethods.prototype.getMediaList = function (pageSize, recordOffset, guid) {
|
|
90
90
|
return __awaiter(this, void 0, void 0, function () {
|
|
91
91
|
var apiPath, resp, err_3;
|
|
92
92
|
return __generator(this, function (_a) {
|
|
93
93
|
switch (_a.label) {
|
|
94
94
|
case 0:
|
|
95
95
|
_a.trys.push([0, 2, , 3]);
|
|
96
|
-
apiPath = "asset/list?pageSize="
|
|
97
|
-
return [4 /*yield*/, this._clientInstance.executeGet(apiPath, this._options)];
|
|
96
|
+
apiPath = "asset/list?pageSize=".concat(pageSize, "&recordOffset=").concat(recordOffset);
|
|
97
|
+
return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
|
|
98
98
|
case 1:
|
|
99
99
|
resp = _a.sent();
|
|
100
100
|
return [2 /*return*/, resp.data];
|
|
@@ -106,62 +106,257 @@ var AssetMethods = /** @class */ (function () {
|
|
|
106
106
|
});
|
|
107
107
|
});
|
|
108
108
|
};
|
|
109
|
-
AssetMethods.prototype.
|
|
110
|
-
return __awaiter(this,
|
|
109
|
+
AssetMethods.prototype.getGalleries = function (guid_1) {
|
|
110
|
+
return __awaiter(this, arguments, void 0, function (guid, search, pageSize, rowIndex) {
|
|
111
111
|
var apiPath, resp, err_4;
|
|
112
|
+
if (search === void 0) { search = null; }
|
|
113
|
+
if (pageSize === void 0) { pageSize = null; }
|
|
114
|
+
if (rowIndex === void 0) { rowIndex = null; }
|
|
112
115
|
return __generator(this, function (_a) {
|
|
113
116
|
switch (_a.label) {
|
|
114
117
|
case 0:
|
|
115
118
|
_a.trys.push([0, 2, , 3]);
|
|
116
|
-
apiPath = "asset/"
|
|
117
|
-
return [4 /*yield*/, this._clientInstance.executeGet(apiPath, this._options)];
|
|
119
|
+
apiPath = "asset/galleries?search=".concat(search, "&pageSize=").concat(pageSize, "&rowIndex=").concat(rowIndex);
|
|
120
|
+
return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
|
|
118
121
|
case 1:
|
|
119
122
|
resp = _a.sent();
|
|
120
123
|
return [2 /*return*/, resp.data];
|
|
121
124
|
case 2:
|
|
122
125
|
err_4 = _a.sent();
|
|
123
|
-
throw new exception_1.Exception("Unable to retrieve
|
|
126
|
+
throw new exception_1.Exception("Unable to retrieve galleries for the website.", err_4);
|
|
124
127
|
case 3: return [2 /*return*/];
|
|
125
128
|
}
|
|
126
129
|
});
|
|
127
130
|
});
|
|
128
131
|
};
|
|
129
|
-
AssetMethods.prototype.
|
|
132
|
+
AssetMethods.prototype.getGalleryById = function (guid, id) {
|
|
130
133
|
return __awaiter(this, void 0, void 0, function () {
|
|
131
134
|
var apiPath, resp, err_5;
|
|
132
135
|
return __generator(this, function (_a) {
|
|
133
136
|
switch (_a.label) {
|
|
134
137
|
case 0:
|
|
135
138
|
_a.trys.push([0, 2, , 3]);
|
|
136
|
-
apiPath = "asset
|
|
137
|
-
return [4 /*yield*/, this._clientInstance.executeGet(apiPath, this._options)];
|
|
139
|
+
apiPath = "/asset/gallery/".concat(id);
|
|
140
|
+
return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
|
|
138
141
|
case 1:
|
|
139
142
|
resp = _a.sent();
|
|
140
143
|
return [2 /*return*/, resp.data];
|
|
141
144
|
case 2:
|
|
142
145
|
err_5 = _a.sent();
|
|
143
|
-
throw new exception_1.Exception("Unable to retrieve
|
|
146
|
+
throw new exception_1.Exception("Unable to retrieve gallery for id ".concat(id), err_5);
|
|
144
147
|
case 3: return [2 /*return*/];
|
|
145
148
|
}
|
|
146
149
|
});
|
|
147
150
|
});
|
|
148
151
|
};
|
|
149
|
-
AssetMethods.prototype.
|
|
150
|
-
if (groupingID === void 0) { groupingID = -1; }
|
|
152
|
+
AssetMethods.prototype.getGalleryByName = function (guid, galleryName) {
|
|
151
153
|
return __awaiter(this, void 0, void 0, function () {
|
|
152
154
|
var apiPath, resp, err_6;
|
|
153
155
|
return __generator(this, function (_a) {
|
|
154
156
|
switch (_a.label) {
|
|
155
157
|
case 0:
|
|
156
158
|
_a.trys.push([0, 2, , 3]);
|
|
157
|
-
apiPath = "asset/
|
|
158
|
-
return [4 /*yield*/, this._clientInstance.
|
|
159
|
+
apiPath = "/asset/gallery?galleryName=".concat(galleryName);
|
|
160
|
+
return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
|
|
159
161
|
case 1:
|
|
160
162
|
resp = _a.sent();
|
|
161
163
|
return [2 /*return*/, resp.data];
|
|
162
164
|
case 2:
|
|
163
165
|
err_6 = _a.sent();
|
|
164
|
-
throw new exception_1.Exception("Unable to
|
|
166
|
+
throw new exception_1.Exception("Unable to retrieve gallery for name ".concat(galleryName), err_6);
|
|
167
|
+
case 3: return [2 /*return*/];
|
|
168
|
+
}
|
|
169
|
+
});
|
|
170
|
+
});
|
|
171
|
+
};
|
|
172
|
+
AssetMethods.prototype.getDefaultContainer = function (guid) {
|
|
173
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
174
|
+
var apiPath, resp, err_7;
|
|
175
|
+
return __generator(this, function (_a) {
|
|
176
|
+
switch (_a.label) {
|
|
177
|
+
case 0:
|
|
178
|
+
_a.trys.push([0, 2, , 3]);
|
|
179
|
+
apiPath = "/asset/container";
|
|
180
|
+
return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
|
|
181
|
+
case 1:
|
|
182
|
+
resp = _a.sent();
|
|
183
|
+
return [2 /*return*/, resp.data];
|
|
184
|
+
case 2:
|
|
185
|
+
err_7 = _a.sent();
|
|
186
|
+
throw new exception_1.Exception("Unable to retrieve container for guid ".concat(guid), err_7);
|
|
187
|
+
case 3: return [2 /*return*/];
|
|
188
|
+
}
|
|
189
|
+
});
|
|
190
|
+
});
|
|
191
|
+
};
|
|
192
|
+
AssetMethods.prototype.saveGallery = function (guid, gallery) {
|
|
193
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
194
|
+
var apiPath, resp, err_8;
|
|
195
|
+
return __generator(this, function (_a) {
|
|
196
|
+
switch (_a.label) {
|
|
197
|
+
case 0:
|
|
198
|
+
_a.trys.push([0, 2, , 3]);
|
|
199
|
+
apiPath = "/asset/gallery";
|
|
200
|
+
return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, gallery)];
|
|
201
|
+
case 1:
|
|
202
|
+
resp = _a.sent();
|
|
203
|
+
return [2 /*return*/, resp.data];
|
|
204
|
+
case 2:
|
|
205
|
+
err_8 = _a.sent();
|
|
206
|
+
throw new exception_1.Exception("Unable to save gallery", err_8);
|
|
207
|
+
case 3: return [2 /*return*/];
|
|
208
|
+
}
|
|
209
|
+
});
|
|
210
|
+
});
|
|
211
|
+
};
|
|
212
|
+
AssetMethods.prototype.deleteGallery = function (guid, id) {
|
|
213
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
214
|
+
var apiPath, resp, err_9;
|
|
215
|
+
return __generator(this, function (_a) {
|
|
216
|
+
switch (_a.label) {
|
|
217
|
+
case 0:
|
|
218
|
+
_a.trys.push([0, 2, , 3]);
|
|
219
|
+
apiPath = "/asset/gallery/".concat(id);
|
|
220
|
+
return [4 /*yield*/, this._clientInstance.executeDelete(apiPath, guid, this._options.token)];
|
|
221
|
+
case 1:
|
|
222
|
+
resp = _a.sent();
|
|
223
|
+
return [2 /*return*/, resp.data];
|
|
224
|
+
case 2:
|
|
225
|
+
err_9 = _a.sent();
|
|
226
|
+
throw new exception_1.Exception("Unable to delete gallery for id ".concat(id), err_9);
|
|
227
|
+
case 3: return [2 /*return*/];
|
|
228
|
+
}
|
|
229
|
+
});
|
|
230
|
+
});
|
|
231
|
+
};
|
|
232
|
+
AssetMethods.prototype.getAssetByID = function (mediaID, guid) {
|
|
233
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
234
|
+
var apiPath, resp, err_10;
|
|
235
|
+
return __generator(this, function (_a) {
|
|
236
|
+
switch (_a.label) {
|
|
237
|
+
case 0:
|
|
238
|
+
_a.trys.push([0, 2, , 3]);
|
|
239
|
+
apiPath = "asset/".concat(mediaID);
|
|
240
|
+
return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
|
|
241
|
+
case 1:
|
|
242
|
+
resp = _a.sent();
|
|
243
|
+
return [2 /*return*/, resp.data];
|
|
244
|
+
case 2:
|
|
245
|
+
err_10 = _a.sent();
|
|
246
|
+
throw new exception_1.Exception("Unable to retrieve asset for mediaID ".concat(mediaID), err_10);
|
|
247
|
+
case 3: return [2 /*return*/];
|
|
248
|
+
}
|
|
249
|
+
});
|
|
250
|
+
});
|
|
251
|
+
};
|
|
252
|
+
AssetMethods.prototype.getAssetByUrl = function (url, guid) {
|
|
253
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
254
|
+
var apiPath, resp, err_11;
|
|
255
|
+
return __generator(this, function (_a) {
|
|
256
|
+
switch (_a.label) {
|
|
257
|
+
case 0:
|
|
258
|
+
_a.trys.push([0, 2, , 3]);
|
|
259
|
+
apiPath = "asset?url=".concat(url);
|
|
260
|
+
return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
|
|
261
|
+
case 1:
|
|
262
|
+
resp = _a.sent();
|
|
263
|
+
return [2 /*return*/, resp.data];
|
|
264
|
+
case 2:
|
|
265
|
+
err_11 = _a.sent();
|
|
266
|
+
throw new exception_1.Exception("Unable to retrieve asset for url ".concat(url), err_11);
|
|
267
|
+
case 3: return [2 /*return*/];
|
|
268
|
+
}
|
|
269
|
+
});
|
|
270
|
+
});
|
|
271
|
+
};
|
|
272
|
+
/**
|
|
273
|
+
* Uploads a file to the specified folder path.
|
|
274
|
+
*
|
|
275
|
+
* @param {*} formData - FormData object that axios is expecting for the Upload.
|
|
276
|
+
* @param {string} agilityFolderPath
|
|
277
|
+
* @param {string} guid
|
|
278
|
+
* @param {number} [groupingID=-1]
|
|
279
|
+
* @returns
|
|
280
|
+
* @memberof AssetMethods
|
|
281
|
+
*/
|
|
282
|
+
AssetMethods.prototype.upload = function (formData_1, agilityFolderPath_1, guid_1) {
|
|
283
|
+
return __awaiter(this, arguments, void 0, function (formData, agilityFolderPath, guid, groupingID) {
|
|
284
|
+
var apiPath, resp, err_12;
|
|
285
|
+
if (groupingID === void 0) { groupingID = -1; }
|
|
286
|
+
return __generator(this, function (_a) {
|
|
287
|
+
switch (_a.label) {
|
|
288
|
+
case 0:
|
|
289
|
+
_a.trys.push([0, 2, , 3]);
|
|
290
|
+
apiPath = "asset/upload?folderPath=".concat(agilityFolderPath, "&groupingID=").concat(groupingID);
|
|
291
|
+
return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, formData)];
|
|
292
|
+
case 1:
|
|
293
|
+
resp = _a.sent();
|
|
294
|
+
return [2 /*return*/, resp.data];
|
|
295
|
+
case 2:
|
|
296
|
+
err_12 = _a.sent();
|
|
297
|
+
throw new exception_1.Exception("Unable to upload media.", err_12);
|
|
298
|
+
case 3: return [2 /*return*/];
|
|
299
|
+
}
|
|
300
|
+
});
|
|
301
|
+
});
|
|
302
|
+
};
|
|
303
|
+
AssetMethods.prototype.createFolder = function (originKey, guid) {
|
|
304
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
305
|
+
var apiPath, resp, err_13;
|
|
306
|
+
return __generator(this, function (_a) {
|
|
307
|
+
switch (_a.label) {
|
|
308
|
+
case 0:
|
|
309
|
+
_a.trys.push([0, 2, , 3]);
|
|
310
|
+
apiPath = "asset/folder?originKey=".concat(originKey);
|
|
311
|
+
return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, null)];
|
|
312
|
+
case 1:
|
|
313
|
+
resp = _a.sent();
|
|
314
|
+
return [2 /*return*/, resp.data];
|
|
315
|
+
case 2:
|
|
316
|
+
err_13 = _a.sent();
|
|
317
|
+
throw new exception_1.Exception('Unable to create folder.', err_13);
|
|
318
|
+
case 3: return [2 /*return*/];
|
|
319
|
+
}
|
|
320
|
+
});
|
|
321
|
+
});
|
|
322
|
+
};
|
|
323
|
+
AssetMethods.prototype.deleteFolder = function (originKey_1, guid_1) {
|
|
324
|
+
return __awaiter(this, arguments, void 0, function (originKey, guid, mediaID) {
|
|
325
|
+
var apiPath, err_14;
|
|
326
|
+
if (mediaID === void 0) { mediaID = 0; }
|
|
327
|
+
return __generator(this, function (_a) {
|
|
328
|
+
switch (_a.label) {
|
|
329
|
+
case 0:
|
|
330
|
+
_a.trys.push([0, 2, , 3]);
|
|
331
|
+
apiPath = "asset/folder/delete?originKey=".concat(originKey, "&mediaID=").concat(mediaID);
|
|
332
|
+
return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, null)];
|
|
333
|
+
case 1:
|
|
334
|
+
_a.sent();
|
|
335
|
+
return [3 /*break*/, 3];
|
|
336
|
+
case 2:
|
|
337
|
+
err_14 = _a.sent();
|
|
338
|
+
throw new exception_1.Exception('Unable to delete folder.', err_14);
|
|
339
|
+
case 3: return [2 /*return*/];
|
|
340
|
+
}
|
|
341
|
+
});
|
|
342
|
+
});
|
|
343
|
+
};
|
|
344
|
+
AssetMethods.prototype.renameFolder = function (folderName_1, newFolderName_1, guid_1) {
|
|
345
|
+
return __awaiter(this, arguments, void 0, function (folderName, newFolderName, guid, mediaID) {
|
|
346
|
+
var apiPath, err_15;
|
|
347
|
+
if (mediaID === void 0) { mediaID = 0; }
|
|
348
|
+
return __generator(this, function (_a) {
|
|
349
|
+
switch (_a.label) {
|
|
350
|
+
case 0:
|
|
351
|
+
_a.trys.push([0, 2, , 3]);
|
|
352
|
+
apiPath = "asset/folder/rename?folderName=".concat(folderName, "&newFolderName=").concat(newFolderName, "&mediaID=").concat(mediaID);
|
|
353
|
+
return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, null)];
|
|
354
|
+
case 1:
|
|
355
|
+
_a.sent();
|
|
356
|
+
return [3 /*break*/, 3];
|
|
357
|
+
case 2:
|
|
358
|
+
err_15 = _a.sent();
|
|
359
|
+
throw new exception_1.Exception('Unable to rename folder.', err_15);
|
|
165
360
|
case 3: return [2 /*return*/];
|
|
166
361
|
}
|
|
167
362
|
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"assetMethods.js","sourceRoot":"","sources":["../../src/apiMethods/assetMethods.ts"],"names":[],"mappings":";;;AACA,qDAAkD;AAElD,mDAAgD;AAKhD,MAAa,YAAY;IAIrB,YAAY,OAAgB;QACxB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,eAAe,GAAG,IAAI,+BAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,IAAY;QAC1C,IAAG,CAAC;YACF,IAAI,OAAO,GAAG,gBAAgB,OAAO,EAAE,CAAC;YACxC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC1F,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;gBACX,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;gBACpC,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAI,CAAC,MAAM,cAAc,SAAS,EAAE,CAAC,CAAC;YAC9F,CAAC;YACD,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,6CAA6C;QACzE,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,2CAA2C,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;QAC1F,CAAC;IACL,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAe,EAAE,SAAiB,EAAE,IAAY;QAC3D,IAAG,CAAC;YACF,IAAI,MAAM,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAA;YAC1C,IAAI,OAAO,GAAG,cAAc,OAAO,cAAc,MAAM,EAAE,CAAC;YAE1D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC9F,OAAO,IAAI,CAAC,IAAa,CAAC;QAC5B,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,yCAAyC,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;QACxF,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,QAAgB,EAAE,YAAoB,EAAE,IAAY;QACnE,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,uBAAuB,QAAQ,iBAAiB,YAAY,EAAE,CAAC;YAE7E,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACvF,OAAO,IAAI,CAAC,IAAsB,CAAC;QACvC,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,4CAA4C,EAAE,UAAU,CAAC,CAAC;QAClF,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,IAAY,EAAE,SAAwB,IAAI,EAAE,WAA0B,IAAI,EAAE,WAA0B,IAAI;QACzH,IAAG,CAAC;YACA,qDAAqD;YACrD,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;YAC1C,IAAI,MAAM;gBAAE,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC9C,IAAI,QAAQ,KAAK,IAAI;gBAAE,WAAW,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;YACxE,IAAI,QAAQ,KAAK,IAAI;gBAAE,WAAW,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;YACxE,IAAI,OAAO,GAAG,mBAAmB,WAAW,CAAC,QAAQ,EAAE,EAAE,CAAC;YAE1D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACvF,OAAO,IAAI,CAAC,IAAsB,CAAC;QACvC,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,+CAA+C,EAAE,UAAU,CAAC,CAAC;QACrF,CAAC;IACL,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,IAAY,EAAE,EAAU;QACzC,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,kBAAkB,EAAE,EAAE,CAAC;YAErC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACvF,OAAO,IAAI,CAAC,IAA0B,CAAA;QAC1C,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,qCAAqC,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;QAC/E,CAAC;IACL,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,IAAY,EAAE,WAAmB;QACpD,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,8BAA8B,WAAW,EAAE,CAAC;YAE1D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACvF,OAAO,IAAI,CAAC,IAA0B,CAAA;QAC1C,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,uCAAuC,WAAW,EAAE,EAAE,UAAU,CAAC,CAAC;QAC1F,CAAC;IACL,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,IAAY;QAClC,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,kBAAkB,CAAC;YAEjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACvF,OAAO,IAAI,CAAC,IAAsB,CAAC;QACvC,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,yCAAyC,IAAI,EAAE,EAAE,UAAU,CAAC,CAAC;QACrF,CAAC;IACL,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAY,EAAE,OAA2B;QACvD,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,gBAAgB,CAAC;YAE/B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACjG,OAAO,IAAI,CAAC,IAA0B,CAAC;QAC3C,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,wBAAwB,EAAE,UAAU,CAAC,CAAC;QAC9D,CAAC;IACL,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,EAAU;QACxC,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,kBAAkB,EAAE,EAAE,CAAA;YAEpC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC1F,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;gBACX,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;gBACpC,MAAM,IAAI,KAAK,CAAC,uCAAuC,IAAI,CAAC,MAAM,cAAc,SAAS,EAAE,CAAC,CAAC;YACjG,CAAC;YACD,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,6CAA6C;QAC3E,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,mCAAmC,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;QAC7E,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,OAAe,EAAE,IAAY;QAC5C,IAAG,CAAC;YACF,IAAI,OAAO,GAAG,SAAS,OAAO,EAAE,CAAC;YACjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEvF,OAAO,IAAI,CAAC,IAAa,CAAC;QAC5B,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,wCAAwC,OAAO,EAAE,EAAE,UAAU,CAAC,CAAC;QACvF,CAAC;IACL,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,GAAW,EAAE,IAAY;QACzC,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,aAAa,GAAG,EAAE,CAAC;YACjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEvF,OAAO,IAAI,CAAC,IAAa,CAAC;QAC9B,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,oCAAoC,GAAG,EAAE,EAAE,UAAU,CAAC,CAAC;QAC/E,CAAC;IACL,CAAC;IAED;;;;;;;;;GASD;IACC,KAAK,CAAC,MAAM,CAAC,QAAa,EAAE,iBAAyB,EAAE,IAAY,EAAE,aAAqB,CAAC,CAAC;QACxF,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,2BAA2B,iBAAiB,eAAe,UAAU,EAAE,CAAC;YACtF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAElG,OAAO,IAAI,CAAC,IAAe,CAAC;QAChC,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,yBAAyB,EAAE,UAAU,CAAC,CAAC;QAC/D,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,SAAiB,EAAE,IAAY;QAC9C,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,0BAA0B,SAAS,EAAE,CAAC;YACpD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAE9F,OAAO,IAAI,CAAC,IAAa,CAAC;QAC9B,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,0BAA0B,EAAE,UAAU,CAAC,CAAC;QAChE,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,SAAiB,EAAE,IAAY,EAAE,UAAkB,CAAC;QACnE,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,iCAAiC,SAAS,YAAY,OAAO,EAAE,CAAC;YAC9E,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACjF,iEAAiE;QACrE,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,0BAA0B,EAAE,UAAU,CAAC,CAAC;QAChE,CAAC;IACL,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,UAAkB,EAAE,aAAqB,EAAE,IAAY,EAAE,UAAkB,CAAC;QAC3F,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,kCAAkC,UAAU,kBAAkB,aAAa,YAAY,OAAO,EAAE,CAAC;YAC/G,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACjF,iEAAiE;QACrE,CAAC;QAAC,OAAM,GAAG,EAAC,CAAC;YACT,MAAM,UAAU,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,IAAI,qBAAS,CAAC,0BAA0B,EAAE,UAAU,CAAC,CAAC;QAChE,CAAC;IACL,CAAC;CACJ;AAjND,oCAiNC"}
|
|
@@ -0,0 +1,239 @@
|
|
|
1
|
+
import { Options } from "../models/options";
|
|
2
|
+
import { OAuthTokenResponse, AuthUrlOptions, TokenExchangeRequest, TokenRefreshRequest, TokenValidationResponse, TokenManagerConfig, AuthState } from "../models/authTokens";
|
|
3
|
+
/**
|
|
4
|
+
* Internal authentication methods - not exposed publicly
|
|
5
|
+
* Handles OAuth flow and token management with secure storage
|
|
6
|
+
*/
|
|
7
|
+
export declare class AuthMethods {
|
|
8
|
+
private _options;
|
|
9
|
+
private _clientInstance;
|
|
10
|
+
private _tokenStorage;
|
|
11
|
+
constructor(options: Options);
|
|
12
|
+
/**
|
|
13
|
+
* Generate OAuth authorization URL for user authentication
|
|
14
|
+
* @param options - Authorization URL configuration options
|
|
15
|
+
* @returns Complete authorization URL for user redirection
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```typescript
|
|
19
|
+
* const client = new ApiClient();
|
|
20
|
+
* const authUrl = client.authMethods.generateAuthUrl({
|
|
21
|
+
* redirectUri: 'https://yourapp.com/auth/callback',
|
|
22
|
+
* scope: 'openid profile email offline_access',
|
|
23
|
+
* state: 'random-state-string'
|
|
24
|
+
* });
|
|
25
|
+
*
|
|
26
|
+
* // Redirect user to authorization URL
|
|
27
|
+
* window.location.href = authUrl;
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
generateAuthUrl(options: AuthUrlOptions): string;
|
|
31
|
+
/**
|
|
32
|
+
* Exchange authorization code for access tokens
|
|
33
|
+
* Automatically stores tokens securely and sets them in Options
|
|
34
|
+
* @param request - Token exchange request parameters
|
|
35
|
+
* @returns Promise containing access and refresh tokens
|
|
36
|
+
*/
|
|
37
|
+
exchangeCodeForToken(request: TokenExchangeRequest, region?: string): Promise<OAuthTokenResponse>;
|
|
38
|
+
/**
|
|
39
|
+
* Refresh an expired access token using refresh token
|
|
40
|
+
* Automatically updates stored tokens and Options
|
|
41
|
+
* @param request - Token refresh request parameters
|
|
42
|
+
* @returns Promise containing new access token
|
|
43
|
+
*/
|
|
44
|
+
refreshAccessToken(request: TokenRefreshRequest, region?: string): Promise<OAuthTokenResponse>;
|
|
45
|
+
/**
|
|
46
|
+
* Validate an access token and get token information
|
|
47
|
+
* @param token - Access token to validate
|
|
48
|
+
* @returns Promise containing token validation information
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* ```typescript
|
|
52
|
+
* const client = new ApiClient();
|
|
53
|
+
*
|
|
54
|
+
* const tokenInfo = await client.authMethods.validateToken('your_access_token');
|
|
55
|
+
*
|
|
56
|
+
* if (tokenInfo.active) {
|
|
57
|
+
* console.log('Token is valid');
|
|
58
|
+
* console.log('Expires at:', new Date(tokenInfo.exp * 1000));
|
|
59
|
+
* console.log('Scope:', tokenInfo.scope);
|
|
60
|
+
* } else {
|
|
61
|
+
* console.log('Token is invalid or expired');
|
|
62
|
+
* }
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
65
|
+
validateToken(token: string, region?: string): Promise<TokenValidationResponse>;
|
|
66
|
+
/**
|
|
67
|
+
* Revoke an access token or refresh token
|
|
68
|
+
* @param token - Token to revoke
|
|
69
|
+
* @returns Promise indicating success
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```typescript
|
|
73
|
+
* const client = new ApiClient();
|
|
74
|
+
*
|
|
75
|
+
* // Revoke access token on logout
|
|
76
|
+
* await client.authMethods.revokeToken('access_token');
|
|
77
|
+
*
|
|
78
|
+
* // Clear the client's token
|
|
79
|
+
* client.clearToken();
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
revokeToken(token: string, region?: string): Promise<void>;
|
|
83
|
+
/**
|
|
84
|
+
* Set the access token in the shared Options instance
|
|
85
|
+
* Also stores token in keytar for consistency
|
|
86
|
+
* @param token - Valid access token
|
|
87
|
+
*/
|
|
88
|
+
setAccessToken(token: string): Promise<void>;
|
|
89
|
+
/**
|
|
90
|
+
* Get a valid access token - automatically refreshes if expired
|
|
91
|
+
* @returns Promise containing valid access token or null if authentication required
|
|
92
|
+
*/
|
|
93
|
+
getValidAccessToken(): Promise<string | null>;
|
|
94
|
+
/**
|
|
95
|
+
* Perform OAuth authentication flow
|
|
96
|
+
* @param options - OAuth configuration options
|
|
97
|
+
* @returns Promise resolving when authentication is complete
|
|
98
|
+
*/
|
|
99
|
+
performOAuthFlow(options: AuthUrlOptions): Promise<void>;
|
|
100
|
+
/**
|
|
101
|
+
* Clear all authentication data
|
|
102
|
+
*/
|
|
103
|
+
clearAuthentication(): Promise<void>;
|
|
104
|
+
/**
|
|
105
|
+
* Check if user is authenticated (has valid token)
|
|
106
|
+
* @returns Promise resolving to true if authenticated
|
|
107
|
+
*/
|
|
108
|
+
isAuthenticated(): Promise<boolean>;
|
|
109
|
+
/**
|
|
110
|
+
* Check if a token is expired based on expiration timestamp
|
|
111
|
+
* @param expiresAt - Token expiration timestamp (seconds since epoch)
|
|
112
|
+
* @param bufferSeconds - Buffer time in seconds to consider token expired early (default: 300 = 5 minutes)
|
|
113
|
+
* @returns True if token is expired or will expire within buffer time
|
|
114
|
+
*
|
|
115
|
+
* @example
|
|
116
|
+
* ```typescript
|
|
117
|
+
* const client = new ApiClient();
|
|
118
|
+
*
|
|
119
|
+
* const expiresAt = Math.floor(Date.now() / 1000) + 3600; // 1 hour from now
|
|
120
|
+
*
|
|
121
|
+
* if (client.authMethods.isTokenExpired(expiresAt)) {
|
|
122
|
+
* console.log('Token is expired or will expire soon');
|
|
123
|
+
* // Refresh token or re-authenticate
|
|
124
|
+
* }
|
|
125
|
+
* ```
|
|
126
|
+
*/
|
|
127
|
+
isTokenExpired(expiresAt: number, bufferSeconds?: number): boolean;
|
|
128
|
+
/**
|
|
129
|
+
* Calculate token expiration timestamp from expires_in value
|
|
130
|
+
* @param expiresIn - Token lifetime in seconds
|
|
131
|
+
* @returns Expiration timestamp (seconds since epoch)
|
|
132
|
+
*
|
|
133
|
+
* @example
|
|
134
|
+
* ```typescript
|
|
135
|
+
* const client = new ApiClient();
|
|
136
|
+
*
|
|
137
|
+
* const tokens = await client.authMethods.exchangeCodeForToken(request);
|
|
138
|
+
* const expiresAt = client.authMethods.calculateExpirationTime(tokens.expires_in);
|
|
139
|
+
*
|
|
140
|
+
* // Store expiration time for later use
|
|
141
|
+
* localStorage.setItem('token_expires_at', expiresAt.toString());
|
|
142
|
+
* ```
|
|
143
|
+
*/
|
|
144
|
+
calculateExpirationTime(expiresIn: number): number;
|
|
145
|
+
/**
|
|
146
|
+
* Generate a cryptographically secure random state parameter for OAuth
|
|
147
|
+
* @param length - Length of the state string (default: 32)
|
|
148
|
+
* @returns Random state string
|
|
149
|
+
*
|
|
150
|
+
* @example
|
|
151
|
+
* ```typescript
|
|
152
|
+
* const client = new ApiClient();
|
|
153
|
+
*
|
|
154
|
+
* const state = client.authMethods.generateState();
|
|
155
|
+
*
|
|
156
|
+
* // Store state for validation
|
|
157
|
+
* sessionStorage.setItem('oauth_state', state);
|
|
158
|
+
*
|
|
159
|
+
* // Use in authorization URL
|
|
160
|
+
* const authUrl = client.authMethods.generateAuthUrl({
|
|
161
|
+
* redirectUri: 'https://yourapp.com/callback',
|
|
162
|
+
* state: state
|
|
163
|
+
* });
|
|
164
|
+
* ```
|
|
165
|
+
*/
|
|
166
|
+
generateState(length?: number): string;
|
|
167
|
+
/**
|
|
168
|
+
* Create a token manager for automatic token refresh
|
|
169
|
+
* @param config - Token manager configuration
|
|
170
|
+
* @returns Token manager instance
|
|
171
|
+
*
|
|
172
|
+
* @example
|
|
173
|
+
* ```typescript
|
|
174
|
+
* const client = new ApiClient();
|
|
175
|
+
*
|
|
176
|
+
* const tokenManager = client.authMethods.createTokenManager({
|
|
177
|
+
* accessToken: 'current_access_token',
|
|
178
|
+
* refreshToken: 'current_refresh_token',
|
|
179
|
+
* expiresAt: 1234567890
|
|
180
|
+
* });
|
|
181
|
+
*
|
|
182
|
+
* // Get valid token (auto-refreshes if needed and updates client)
|
|
183
|
+
* const validToken = await tokenManager.getValidToken();
|
|
184
|
+
*
|
|
185
|
+
* // Client is now updated with fresh token - make API calls
|
|
186
|
+
* const content = await client.contentMethods.getContentItem(123, guid, locale);
|
|
187
|
+
* ```
|
|
188
|
+
*/
|
|
189
|
+
createTokenManager(config: TokenManagerConfig): TokenManager;
|
|
190
|
+
/**
|
|
191
|
+
* Get current authentication state
|
|
192
|
+
* @param token - Current access token
|
|
193
|
+
* @param expiresAt - Token expiration timestamp
|
|
194
|
+
* @param refreshToken - Optional refresh token
|
|
195
|
+
* @returns Authentication state information
|
|
196
|
+
*
|
|
197
|
+
* @example
|
|
198
|
+
* ```typescript
|
|
199
|
+
* const client = new ApiClient();
|
|
200
|
+
*
|
|
201
|
+
* const authState = client.authMethods.getAuthState(
|
|
202
|
+
* localStorage.getItem('access_token'),
|
|
203
|
+
* parseInt(localStorage.getItem('token_expires_at')),
|
|
204
|
+
* localStorage.getItem('refresh_token')
|
|
205
|
+
* );
|
|
206
|
+
*
|
|
207
|
+
* if (authState.isAuthenticated) {
|
|
208
|
+
* console.log('User is authenticated');
|
|
209
|
+
* } else {
|
|
210
|
+
* console.log('User needs to authenticate');
|
|
211
|
+
* }
|
|
212
|
+
* ```
|
|
213
|
+
*/
|
|
214
|
+
getAuthState(token?: string, expiresAt?: number, refreshToken?: string): AuthState;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* Token manager class for automatic token refresh
|
|
218
|
+
*/
|
|
219
|
+
export declare class TokenManager {
|
|
220
|
+
private authMethods;
|
|
221
|
+
private config;
|
|
222
|
+
constructor(authMethods: AuthMethods, config: TokenManagerConfig);
|
|
223
|
+
/**
|
|
224
|
+
* Get a valid access token, refreshing if necessary
|
|
225
|
+
* This automatically updates the shared token in the AuthMethods instance
|
|
226
|
+
* @returns Promise containing valid access token
|
|
227
|
+
*/
|
|
228
|
+
getValidToken(): Promise<string>;
|
|
229
|
+
/**
|
|
230
|
+
* Update the token configuration
|
|
231
|
+
* @param config - New token configuration
|
|
232
|
+
*/
|
|
233
|
+
updateConfig(config: Partial<TokenManagerConfig>): void;
|
|
234
|
+
/**
|
|
235
|
+
* Get current token configuration
|
|
236
|
+
* @returns Current token configuration
|
|
237
|
+
*/
|
|
238
|
+
getConfig(): TokenManagerConfig;
|
|
239
|
+
}
|