@agility/management-sdk 0.1.37 → 0.1.39

package/dist/apiMethods/instanceMethods.d.ts

@@ -1,9 +1,22 @@
 import { Options } from "../models/options";
 import { ClientInstance } from "./clientInstance";
 import { Locales } from "../models/locales";
+import { FetchApiStatus, FetchApiSyncMode } from "../models/fetchApiStatus";
 export declare class InstanceMethods {
     _options: Options;
     _clientInstance: ClientInstance;
     constructor(options: Options);
     getLocales(guid: string): Promise<Locales[]>;
+    /**
+     * Gets the Fetch API sync status for an instance.
+     * Use this to check if changes made via the Management API have propagated to the Fetch API CDNs.
+     * This is particularly useful after large batch operations or batch workflows to verify
+     * that content changes are available on the CDN before proceeding with dependent operations.
+     *
+     * @param guid - The website GUID
+     * @param mode - Sync mode: 'fetch' (live/published content) or 'preview' (preview content). Defaults to 'fetch'.
+     * @param waitForCompletion - If true, polls until sync is complete. Defaults to false.
+     * @returns The sync status including whether a sync is in progress and version information
+     */
+    getFetchApiStatus(guid: string, mode?: FetchApiSyncMode, waitForCompletion?: boolean): Promise<FetchApiStatus>;
 }

package/dist/apiMethods/instanceMethods.js

@@ -64,6 +64,54 @@ var InstanceMethods = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Gets the Fetch API sync status for an instance.
+     * Use this to check if changes made via the Management API have propagated to the Fetch API CDNs.
+     * This is particularly useful after large batch operations or batch workflows to verify
+     * that content changes are available on the CDN before proceeding with dependent operations.
+     *
+     * @param guid - The website GUID
+     * @param mode - Sync mode: 'fetch' (live/published content) or 'preview' (preview content). Defaults to 'fetch'.
+     * @param waitForCompletion - If true, polls until sync is complete. Defaults to false.
+     * @returns The sync status including whether a sync is in progress and version information
+     */
+    InstanceMethods.prototype.getFetchApiStatus = function (guid_1) {
+        return __awaiter(this, arguments, void 0, function (guid, mode, waitForCompletion) {
+            var apiPath, resp, resp, status_1, err_2;
+            if (mode === void 0) { mode = 'fetch'; }
+            if (waitForCompletion === void 0) { waitForCompletion = false; }
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 6, , 7]);
+                        apiPath = "fetch-api-status?mode=".concat(mode);
+                        if (!!waitForCompletion) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp.data];
+                    case 2:
+                        if (!true) return [3 /*break*/, 5];
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
+                    case 3:
+                        resp = _a.sent();
+                        status_1 = resp.data;
+                        if (!status_1.inProgress) {
+                            return [2 /*return*/, status_1];
+                        }
+                        return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, 2000); })];
+                    case 4:
+                        _a.sent();
+                        return [3 /*break*/, 2];
+                    case 5: return [3 /*break*/, 7];
+                    case 6:
+                        err_2 = _a.sent();
+                        throw new exception_1.Exception("Unable to retrieve Fetch API status.", err_2);
+                    case 7: return [2 /*return*/];
+                }
+            });
+        });
+    };
     return InstanceMethods;
 }());
 exports.InstanceMethods = InstanceMethods;

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export * from "./models/contentItem";
 export * from "./models/contentViewColumn";
 export * from "./models/instanceRole";
 export * from "./models/locales";
+export * from "./models/fetchApiStatus";
 export * from "./models/instanceUser";
 export * from "./models/media";
 export * from "./models/model";

package/dist/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./models/contentItem"), exports);
 __exportStar(require("./models/contentViewColumn"), exports);
 __exportStar(require("./models/instanceRole"), exports);
 __exportStar(require("./models/locales"), exports);
+__exportStar(require("./models/fetchApiStatus"), exports);
 __exportStar(require("./models/instanceUser"), exports);
 __exportStar(require("./models/media"), exports);
 __exportStar(require("./models/model"), exports);

package/dist/models/exception.d.ts

@@ -1,4 +1,8 @@
 export declare class Exception extends Error {
     constructor(message: string, inner?: Error);
     innerError?: Error;
+    /** HTTP status code from the underlying response, when available. */
+    statusCode?: number;
+    /** Raw response body from the underlying response, when available. */
+    responseData?: unknown;
 }

package/dist/models/exception.js

@@ -19,8 +19,24 @@ exports.Exception = void 0;
 var Exception = /** @class */ (function (_super) {
     __extends(Exception, _super);
     function Exception(message, inner) {
-        var _this = _super.call(this, message) || this;
+        var _this = this;
+        var _a, _b, _c, _d;
+        var anyErr = inner;
+        var status = (_a = anyErr === null || anyErr === void 0 ? void 0 : anyErr.response) === null || _a === void 0 ? void 0 : _a.status;
+        var data = (_b = anyErr === null || anyErr === void 0 ? void 0 : anyErr.response) === null || _b === void 0 ? void 0 : _b.data;
+        var detail = data
+            ? (typeof data === "string"
+                ? data
+                : ((_d = (_c = data.exceptionMessage) !== null && _c !== void 0 ? _c : data.message) !== null && _d !== void 0 ? _d : JSON.stringify(data)))
+            : anyErr === null || anyErr === void 0 ? void 0 : anyErr.message;
+        // Surface the server's status + response body in the message. The Management API
+        // (and other callers) only read Error.message, so folding the response detail in here
+        // turns an opaque "Unable to save the container" into
+        // "Unable to save the container (HTTP 500): <server message>".
+        _this = _super.call(this, detail ? "".concat(message).concat(status ? " (HTTP ".concat(status, ")") : "", ": ").concat(detail) : message) || this;
         _this.innerError = inner;
+        _this.statusCode = status;
+        _this.responseData = data;
         return _this;
     }
     return Exception;

package/dist/models/fetchApiStatus.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Represents the sync status of the Fetch API CDN for an instance.
+ * Used to check if changes made via the Management API have propagated to the Fetch API CDNs.
+ */
+export interface FetchApiStatus {
+    /** Record timestamp */
+    timestamp?: string;
+    /** When the sync completed */
+    completionTime?: string;
+    /** Error message if sync failed */
+    errorMessage?: string;
+    /** Indicates if a content sync is currently in progress */
+    inProgress: boolean;
+    /** Number of items affected by the sync */
+    itemsAffected: number;
+    /** Last content version ID synced */
+    lastContentVersionID: number;
+    /** Last deleted content version ID synced */
+    lastDeletedContentVersionID: number;
+    /** Last deleted page version ID synced */
+    lastDeletedPageVersionID: number;
+    /** Lease ID for the sync operation */
+    leaseID?: string;
+    /** Maximum change date processed */
+    maxChangeDate?: string;
+    /** Maximum content model date processed */
+    maxContentModelDate?: string;
+    /** Push type (1 = Preview, 2 = Fetch/Live) */
+    pushType: number;
+    /** When the sync started */
+    startTime?: string;
+    /** The website name */
+    websiteName?: string;
+}
+/**
+ * Sync mode for checking Fetch API status
+ */
+export type FetchApiSyncMode = 'fetch' | 'preview';

package/dist/models/fetchApiStatus.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });