@agility/management-sdk
Version:
Agility CMS Tyescript SDK for Management API.
348 lines (347 loc) • 18.4 kB
JavaScript
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
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;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.BatchMethods = void 0;
var clientInstance_1 = require("./clientInstance");
var batchState_1 = require("../enums/batchState.");
var exception_1 = require("../models/exception");
var BatchMethods = /** @class */ (function () {
function BatchMethods(options) {
this._options = options;
this._clientInstance = new clientInstance_1.ClientInstance(this._options);
}
BatchMethods.prototype.getBatch = function (batchID, guid, expandItems) {
if (expandItems === void 0) { expandItems = true; }
return __awaiter(this, void 0, void 0, function () {
var apiPath, resp, err_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
apiPath = "batch/" + batchID + "?expandItems=" + expandItems;
return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
case 1:
resp = _a.sent();
return [2 /*return*/, resp.data];
case 2:
err_1 = _a.sent();
throw new exception_1.Exception("Unable to retrieve the batch for id: " + batchID, err_1);
case 3: return [2 /*return*/];
}
});
});
};
BatchMethods.prototype.publishBatch = function (batchID, guid, returnBatchId) {
if (returnBatchId === void 0) { returnBatchId = false; }
return __awaiter(this, void 0, void 0, function () {
var apiPath, resp, resultBatchID_1, err_2;
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 3, , 4]);
apiPath = "batch/" + batchID + "/publish";
return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, null)];
case 1:
resp = _a.sent();
resultBatchID_1 = resp.data;
// If user wants batchID immediately, return it for custom polling
if (returnBatchId) {
return [2 /*return*/, resultBatchID_1];
}
// Default behavior: wait for completion and return batch ID
return [4 /*yield*/, this.Retry(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getBatch(resultBatchID_1, guid)];
case 1: return [2 /*return*/, _a.sent()];
}
}); }); })];
case 2:
// Default behavior: wait for completion and return batch ID
_a.sent();
return [2 /*return*/, resultBatchID_1];
case 3:
err_2 = _a.sent();
throw new exception_1.Exception("Unable to publish the batch with id: " + batchID, err_2);
case 4: return [2 /*return*/];
}
});
});
};
BatchMethods.prototype.unpublishBatch = function (batchID, guid, returnBatchId) {
if (returnBatchId === void 0) { returnBatchId = false; }
return __awaiter(this, void 0, void 0, function () {
var apiPath, resp, resultBatchID_2, err_3;
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 3, , 4]);
apiPath = "batch/" + batchID + "/unpublish";
return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, null)];
case 1:
resp = _a.sent();
resultBatchID_2 = resp.data;
// If user wants batchID immediately, return it for custom polling
if (returnBatchId) {
return [2 /*return*/, resultBatchID_2];
}
// Default behavior: wait for completion and return batch ID
return [4 /*yield*/, this.Retry(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getBatch(resultBatchID_2, guid)];
case 1: return [2 /*return*/, _a.sent()];
}
}); }); })];
case 2:
// Default behavior: wait for completion and return batch ID
_a.sent();
return [2 /*return*/, resultBatchID_2];
case 3:
err_3 = _a.sent();
throw new exception_1.Exception("Unable to unpublish the batch with id: " + batchID, err_3);
case 4: return [2 /*return*/];
}
});
});
};
BatchMethods.prototype.approveBatch = function (batchID, guid, returnBatchId) {
if (returnBatchId === void 0) { returnBatchId = false; }
return __awaiter(this, void 0, void 0, function () {
var apiPath, resp, resultBatchID_3, err_4;
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 3, , 4]);
apiPath = "batch/" + batchID + "/approve";
return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, null)];
case 1:
resp = _a.sent();
resultBatchID_3 = resp.data;
// If user wants batchID immediately, return it for custom polling
if (returnBatchId) {
return [2 /*return*/, resultBatchID_3];
}
// Default behavior: wait for completion and return batch ID
return [4 /*yield*/, this.Retry(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getBatch(resultBatchID_3, guid)];
case 1: return [2 /*return*/, _a.sent()];
}
}); }); })];
case 2:
// Default behavior: wait for completion and return batch ID
_a.sent();
return [2 /*return*/, resultBatchID_3];
case 3:
err_4 = _a.sent();
throw new exception_1.Exception("Unable to approve the batch with id: " + batchID, err_4);
case 4: return [2 /*return*/];
}
});
});
};
BatchMethods.prototype.declineBatch = function (batchID, guid, returnBatchId) {
if (returnBatchId === void 0) { returnBatchId = false; }
return __awaiter(this, void 0, void 0, function () {
var apiPath, resp, resultBatchID_4, err_5;
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 3, , 4]);
apiPath = "batch/" + batchID + "/decline";
return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, null)];
case 1:
resp = _a.sent();
resultBatchID_4 = resp.data;
// If user wants batchID immediately, return it for custom polling
if (returnBatchId) {
return [2 /*return*/, resultBatchID_4];
}
// Default behavior: wait for completion and return batch ID
return [4 /*yield*/, this.Retry(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getBatch(resultBatchID_4, guid)];
case 1: return [2 /*return*/, _a.sent()];
}
}); }); })];
case 2:
// Default behavior: wait for completion and return batch ID
_a.sent();
return [2 /*return*/, resultBatchID_4];
case 3:
err_5 = _a.sent();
throw new exception_1.Exception("Unable to decline the batch with id: " + batchID, err_5);
case 4: return [2 /*return*/];
}
});
});
};
BatchMethods.prototype.requestApprovalBatch = function (batchID, guid, returnBatchId) {
if (returnBatchId === void 0) { returnBatchId = false; }
return __awaiter(this, void 0, void 0, function () {
var apiPath, resp, resultBatchID_5, err_6;
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 3, , 4]);
apiPath = "batch/" + batchID + "/request-approval";
return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, null)];
case 1:
resp = _a.sent();
resultBatchID_5 = resp.data;
// If user wants batchID immediately, return it for custom polling
if (returnBatchId) {
return [2 /*return*/, resultBatchID_5];
}
// Default behavior: wait for completion and return batch ID
return [4 /*yield*/, this.Retry(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.getBatch(resultBatchID_5, guid)];
case 1: return [2 /*return*/, _a.sent()];
}
}); }); })];
case 2:
// Default behavior: wait for completion and return batch ID
_a.sent();
return [2 /*return*/, resultBatchID_5];
case 3:
err_6 = _a.sent();
throw new exception_1.Exception("Unable to request approval for the batch with id: " + batchID, err_6);
case 4: return [2 /*return*/];
}
});
});
};
/**
* Retrieves all batch-related enum types for developer discovery.
* This method provides all available enum values with their names,
* enabling dynamic UI population and client-side validation.
*
* @param guid - Current website guid
* @returns Promise containing all batch enum types
*
* @example
* ```typescript
* // Get all batch types for UI population
* const types = await client.batchMethods.getBatchTypes(guid);
*
* // Create dropdown options for item types
* const itemTypeOptions = types.itemTypes.map(type => ({
* label: type.name,
* value: type.value
* }));
*
* // Validate operation type
* const isValidOperation = (value: number) =>
* types.workflowOperations.some(op => op.value === value);
* ```
*/
BatchMethods.prototype.getBatchTypes = function (guid) {
return __awaiter(this, void 0, void 0, function () {
var apiPath, resp, err_7;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
apiPath = "batch/types";
return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
case 1:
resp = _a.sent();
return [2 /*return*/, resp.data];
case 2:
err_7 = _a.sent();
throw new exception_1.Exception("Unable to retrieve batch types", err_7);
case 3: return [2 /*return*/];
}
});
});
};
BatchMethods.prototype.Retry = function (method) {
return __awaiter(this, void 0, void 0, function () {
var retryCount, duration, batch, err_8;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
retryCount = this._options.retryCount;
duration = this._options.duration;
if (retryCount <= 0)
throw new Error('Number of retries has been exhausted.');
_a.label = 1;
case 1:
if (!true) return [3 /*break*/, 9];
_a.label = 2;
case 2:
_a.trys.push([2, 7, , 8]);
return [4 /*yield*/, method()];
case 3:
batch = _a.sent();
if (!(batch.batchState === batchState_1.BatchState.Processed)) return [3 /*break*/, 4];
return [2 /*return*/, batch];
case 4:
--retryCount;
if (--retryCount <= 0) {
throw new Error('Timeout exceeded but operation still in progress. Please check the Batches page in the Agility Content Manager app.');
}
return [4 /*yield*/, this.delay(duration)];
case 5:
_a.sent();
_a.label = 6;
case 6: return [3 /*break*/, 8];
case 7:
err_8 = _a.sent();
throw new Error('Timeout exceeded but operation still in progress. Please check the Batches page in the Agility Content Manager app.');
case 8: return [3 /*break*/, 1];
case 9: return [2 /*return*/];
}
});
});
};
BatchMethods.prototype.delay = function (ms) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, new Promise(function (resolve) { return setTimeout(resolve, ms); })];
});
});
};
return BatchMethods;
}());
exports.BatchMethods = BatchMethods;