@amplience/dc-cli
Version:
Dynamic Content CLI Tool
179 lines (178 loc) • 7.98 kB
JavaScript
;
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.handler = exports.builder = exports.coerceLog = exports.LOG_FILENAME = exports.desc = exports.command = void 0;
const dynamic_content_client_factory_1 = __importDefault(require("../../services/dynamic-content-client-factory"));
const archive_log_1 = require("../../common/archive/archive-log");
const confirm_all_content_1 = require("../../common/content-item/confirm-all-content");
const dc_management_sdk_js_1 = require("dc-management-sdk-js");
const log_helpers_1 = require("../../common/log-helpers");
const facet_1 = require("../../common/filter/facet");
const fetch_content_1 = require("../../common/filter/fetch-content");
const progress_bar_1 = require("../../common/progress-bar/progress-bar");
const get_content_items_by_ids_1 = require("../../common/content-item/get-content-items-by-ids");
exports.command = 'archive [id]';
exports.desc = 'Archive Content Items';
const LOG_FILENAME = (platform = process.platform) => (0, log_helpers_1.getDefaultLogPath)('content-item', 'archive', platform);
exports.LOG_FILENAME = LOG_FILENAME;
const coerceLog = (logFile) => (0, log_helpers_1.createLog)(logFile, 'Content Items Archive Log');
exports.coerceLog = coerceLog;
const builder = (yargs) => {
yargs
.positional('id', {
type: 'string',
describe: 'The ID of a content item to be archived. If id is not provided, this command will archive ALL content items through all content repositories in the hub.'
})
.option('repoId', {
type: 'string',
describe: 'The ID of a content repository to search items in to be archived.',
requiresArg: false
})
.option('folderId', {
type: 'string',
describe: 'The ID of a folder to search items in to be archived.',
requiresArg: false
})
.option('facet', {
type: 'string',
describe: "Archive content matching the given facets. Provide facets in the format 'label:example name,locale:en-GB', spaces are allowed between values. A regex can be provided for text filters, surrounded with forward slashes. For more examples, see the readme."
})
.option('revertLog', {
type: 'string',
describe: 'Path to a log file containing content items unarchived in a previous run of the unarchive command.\nWhen provided, archives all content items listed as UNARCHIVE in the log file.',
requiresArg: false
})
.alias('f', 'force')
.option('f', {
type: 'boolean',
boolean: true,
describe: 'If present, there will be no confirmation prompt before archiving the found content.'
})
.alias('s', 'silent')
.option('s', {
type: 'boolean',
boolean: true,
describe: 'If present, no log file will be produced.'
})
.option('ignoreError', {
type: 'boolean',
boolean: true,
describe: 'If present, archive requests that fail will not abort the process.'
})
.option('logFile', {
type: 'string',
default: exports.LOG_FILENAME,
describe: 'Path to a log file to write to.',
coerce: exports.coerceLog
})
.option('name', {
type: 'string',
hidden: true
})
.option('schemaId', {
type: 'string',
hidden: true
})
.option('ignoreSchemaValidation', {
type: 'boolean',
boolean: false,
describe: 'Ignore content item schema validation during archive'
});
};
exports.builder = builder;
const processItems = async ({ contentItems, log, ignoreError, ignoreSchemaValidation }) => {
var _a;
const progress = (0, progress_bar_1.progressBar)(contentItems.length, 0, { title: 'Archiving content items' });
const failedArchives = [];
for (let i = 0; i < contentItems.length; i++) {
try {
const deliveryKey = contentItems[i].body._meta.deliveryKey;
const deliveryKeys = (((_a = contentItems[i].body._meta.deliveryKeys) === null || _a === void 0 ? void 0 : _a.values) || []).map((key) => key.value);
let args = contentItems[i].id;
if (deliveryKey || deliveryKeys.length) {
contentItems[i].body._meta.deliveryKey = null;
contentItems[i].body._meta.deliveryKeys = null;
const updateParams = { ...(ignoreSchemaValidation ? { ignoreSchemaValidation: true } : {}) };
contentItems[i] = await contentItems[i].related.update(contentItems[i], updateParams);
args += ` ${deliveryKey || ''} ${deliveryKeys.join(',')}`;
}
await contentItems[i].related.archive();
progress.increment();
log.addAction('ARCHIVE', `${args}`);
}
catch (e) {
failedArchives.push(contentItems[i]);
progress.increment();
log.addComment(`ARCHIVE FAILED: ${contentItems[i].id}`);
log.addComment(e.toString());
if (ignoreError) {
log.warn(`\nFailed to archive ${contentItems[i].label} (${contentItems[i].id}), continuing.`, e);
}
else {
progress.stop();
log.error(`\nFailed to archive ${contentItems[i].label} (${contentItems[i].id}), aborting.`, e);
break;
}
}
}
progress.stop();
return { failedArchives };
};
const handler = async (argv) => {
const { id, logFile, force, silent, ignoreError, hubId, revertLog, repoId, folderId, ignoreSchemaValidation } = argv;
const log = logFile.open();
const client = (0, dynamic_content_client_factory_1.default)(argv);
const facet = (0, facet_1.withOldFilters)(argv.facet, argv);
const allContent = !id && !facet && !revertLog && !folderId && !repoId;
if (repoId && id) {
log.appendLine('ID of content item is specified, ignoring repository ID');
}
if (id && facet) {
log.appendLine('Please specify either a facet or an ID - not both.');
return;
}
if (repoId && folderId) {
log.appendLine('Folder is specified, ignoring repository ID');
}
if (allContent) {
log.appendLine('No filter was given, archiving all content');
}
let ids = [];
if (id) {
ids = Array.isArray(id) ? id : [id];
}
if (revertLog) {
const log = await new archive_log_1.ArchiveLog().loadFromFile(revertLog);
ids = log.getData('UNARCHIVE');
}
const hub = await client.hubs.get(hubId);
const contentItems = ids.length
? (await (0, get_content_items_by_ids_1.getContentByIds)(client, ids)).filter(item => item.status === dc_management_sdk_js_1.Status.ACTIVE)
: await (0, fetch_content_1.getContent)(client, hub, facet, { repoId, folderId, status: dc_management_sdk_js_1.Status.ACTIVE, enrichItems: true });
if (!contentItems.length) {
log.appendLine('Nothing found to archive, aborting');
return;
}
const missingContentItems = ids.length > 0 ? Boolean(ids.length !== contentItems.length) : false;
log.appendLine(`Found ${contentItems.length} content items to archive`);
if (!force) {
const yes = await (0, confirm_all_content_1.confirmAllContent)('archive', 'content item', allContent, missingContentItems);
if (!yes) {
return;
}
}
const { failedArchives } = await processItems({
contentItems,
log,
ignoreError,
ignoreSchemaValidation
});
const failedArchiveMsg = failedArchives.length
? `with ${failedArchives.length} failed archives - check logs for details`
: ``;
log.appendLine(`Archived content items ${failedArchiveMsg}`);
await log.close(!silent);
};
exports.handler = handler;