Skip to content

Commit 760c8ce

Browse files
author
naman-contentstack
committed
chore: update func/var names according to convention
1 parent b589b1b commit 760c8ce

10 files changed

Lines changed: 136 additions & 136 deletions

File tree

packages/contentstack-bulk-operations/src/base-am-command.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
import { Command } from '@contentstack/cli-command';
22
import { handleAndLogError } from '@contentstack/cli-utilities';
33

4-
import { fillMissingAmFlags } from './utils';
5-
import type { AmAssetFlags } from './interfaces';
4+
import { fillMissingCsAssetsFlags } from './utils';
5+
import type { CsAssetsFlags } from './interfaces';
66

77
/**
8-
* Thin base command for Asset Management operations.
8+
* Thin base command for CS Assets operations.
99
* Handles flag prompting in init() and exposes typed parsedFlags / loggerContext.
10-
* Deliberately does NOT inherit BaseBulkCommand — AM operations use a different API
10+
* Deliberately does NOT inherit BaseBulkCommand — CS Assets operations use a different API
1111
* surface with no stack setup, queue managers, or rate limiters.
1212
*/
13-
export abstract class BaseAmCommand extends Command {
14-
protected parsedFlags!: AmAssetFlags;
13+
export abstract class BaseCsAssetsCommand extends Command {
14+
protected parsedFlags!: CsAssetsFlags;
1515
protected loggerContext!: { module: string };
1616

1717
protected async init(): Promise<void> {
1818
await super.init();
19-
const { flags } = await this.parse(this.constructor as typeof BaseAmCommand);
19+
const { flags } = await this.parse(this.constructor as typeof BaseCsAssetsCommand);
2020
this.loggerContext = { module: this.id ?? 'cm:stacks:bulk-am-assets' };
21-
this.parsedFlags = (await fillMissingAmFlags(flags)) as AmAssetFlags;
21+
this.parsedFlags = (await fillMissingCsAssetsFlags(flags)) as CsAssetsFlags;
2222
}
2323

2424
async catch(error: Error): Promise<void> {

packages/contentstack-bulk-operations/src/commands/cm/stacks/bulk-am-assets.ts

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@ import chalk from 'chalk';
22
import { flags, log, createLogContext, cliux, handleAndLogError, FlagInput } from '@contentstack/cli-utilities';
33

44
import messages, { $t } from '../../../messages';
5-
import { BaseAmCommand } from '../../../base-am-command';
6-
import { AmAssetService } from '../../../services';
5+
import { BaseCsAssetsCommand } from '../../../base-am-command';
6+
import { CsAssetsService } from '../../../services';
77
import {
88
loadAssetUidsFromFile,
99
loadBulkDeleteItemsFromFile,
1010
LoadAssetUidsError,
1111
} from '../../../utils/asset-uids-from-file';
12-
import { generateAmJobStatusUrl } from '../../../utils/bulk-publish-url-generator';
13-
import { AmBulkDeleteItem } from '../../../interfaces';
12+
import { generateCsAssetsJobStatusUrl } from '../../../utils/bulk-publish-url-generator';
13+
import { CsAssetsBulkDeleteItem } from '../../../interfaces';
1414

1515
const COMMAND_ID = 'cm:stacks:bulk-am-assets';
1616

17-
type RegionWithOptionalAmUrl = { csAssetsUrl?: string };
17+
type RegionWithOptionalCsAssetsUrl = { csAssetsUrl?: string };
1818

1919
/**
20-
* AM bulk delete (job) / bulk move — CS Assets API only; asset UIDs come from a JSON file `{ "uids": [...] }`.
20+
* CS Assets bulk delete (job) / bulk move; asset UIDs come from a JSON file `{ "uids": [...] }`.
2121
*/
22-
export default class BulkAmAssets extends BaseAmCommand {
23-
static description = messages.BULK_AM_ASSETS_DESCRIPTION;
22+
export default class BulkCsAssets extends BaseCsAssetsCommand {
23+
static description = messages.BULK_CS_ASSETS_DESCRIPTION;
2424

2525
static examples = [
2626
'<%= config.bin %> <%= command.id %> --operation delete --space-uid am123 --org-uid bltcOrg --locale en-us --asset-uids-file ./assets.json',
@@ -30,27 +30,27 @@ export default class BulkAmAssets extends BaseAmCommand {
3030

3131
static flags: FlagInput = {
3232
operation: flags.string({
33-
description: messages.AM_OPERATION_FLAG,
33+
description: messages.CS_ASSETS_OPERATION_FLAG,
3434
options: ['delete', 'move'],
3535
}),
3636
'space-uid': flags.string({
37-
description: messages.AM_SPACE_UID_FLAG,
37+
description: messages.CS_ASSETS_SPACE_UID_FLAG,
3838
}),
3939
'org-uid': flags.string({
40-
description: messages.AM_ORG_UID_FLAG,
40+
description: messages.CS_ASSETS_ORG_UID_FLAG,
4141
}),
4242
workspace: flags.string({
4343
default: 'main',
44-
description: messages.AM_WORKSPACE_FLAG,
44+
description: messages.CS_ASSETS_WORKSPACE_FLAG,
4545
}),
4646
'asset-uids-file': flags.string({
47-
description: messages.AM_ASSET_UIDS_FILE_FLAG,
47+
description: messages.CS_ASSETS_ASSET_UIDS_FILE_FLAG,
4848
}),
4949
locale: flags.string({
50-
description: messages.AM_LOCALE_FLAG,
50+
description: messages.CS_ASSETS_LOCALE_FLAG,
5151
}),
5252
'target-folder-uid': flags.string({
53-
description: messages.AM_TARGET_FOLDER_FLAG,
53+
description: messages.CS_ASSETS_TARGET_FOLDER_FLAG,
5454
}),
5555
yes: flags.boolean({
5656
char: 'y',
@@ -59,28 +59,28 @@ export default class BulkAmAssets extends BaseAmCommand {
5959
}),
6060
};
6161

62-
private printAmSummary(
62+
private printCsAssetsSummary(
6363
op: 'delete' | 'move',
6464
opts: { jobId?: string; count?: number; folderUid?: string; notice?: string; error?: string; spaceUid?: string }
6565
): void {
6666
if (opts.error) {
67-
log.error($t(messages.AM_OPERATION_FAILED, { operation: op }), this.loggerContext);
67+
log.error($t(messages.CS_ASSETS_OPERATION_FAILED, { operation: op }), this.loggerContext);
6868
log.error(opts.error, this.loggerContext);
6969
} else if (op === 'delete') {
70-
log.success($t(messages.AM_DELETE_SUCCESS), this.loggerContext);
71-
if (opts.jobId) log.info($t(messages.AM_DELETE_JOB_ID, { jobId: opts.jobId }), this.loggerContext);
72-
log.info($t(messages.AM_DELETE_ASYNC_NOTE), this.loggerContext);
73-
const statusUrl = generateAmJobStatusUrl(opts.spaceUid);
70+
log.success($t(messages.CS_ASSETS_DELETE_SUCCESS), this.loggerContext);
71+
if (opts.jobId) log.info($t(messages.CS_ASSETS_DELETE_JOB_ID, { jobId: opts.jobId }), this.loggerContext);
72+
log.info($t(messages.CS_ASSETS_DELETE_ASYNC_NOTE), this.loggerContext);
73+
const statusUrl = generateCsAssetsJobStatusUrl(opts.spaceUid);
7474
if (statusUrl) log.info(statusUrl, this.loggerContext);
7575
} else {
76-
log.success($t(messages.AM_MOVE_SUCCESS), this.loggerContext);
76+
log.success($t(messages.CS_ASSETS_MOVE_SUCCESS), this.loggerContext);
7777
if (opts.count !== undefined && opts.folderUid) {
7878
log.info(
79-
$t(messages.AM_MOVE_ASSETS_COUNT, { count: opts.count, folderUid: opts.folderUid }),
79+
$t(messages.CS_ASSETS_MOVE_ASSETS_COUNT, { count: opts.count, folderUid: opts.folderUid }),
8080
this.loggerContext
8181
);
8282
}
83-
const statusUrl = generateAmJobStatusUrl(opts.spaceUid);
83+
const statusUrl = generateCsAssetsJobStatusUrl(opts.spaceUid);
8484
if (statusUrl) log.info(statusUrl, this.loggerContext);
8585
}
8686
if (opts.notice) log.info(opts.notice, this.loggerContext);
@@ -90,11 +90,11 @@ export default class BulkAmAssets extends BaseAmCommand {
9090
const pathShown = e.filePath;
9191
if (e.kind === 'READ') {
9292
log.error(
93-
$t(messages.AM_ASSET_UIDS_FILE_READ_FAILED, { path: pathShown, detail: e.message }),
93+
$t(messages.CS_ASSETS_ASSET_UIDS_FILE_READ_FAILED, { path: pathShown, detail: e.message }),
9494
this.loggerContext
9595
);
9696
} else {
97-
log.error($t(messages.AM_ASSET_UIDS_FILE_INVALID, { path: pathShown, detail: e.message }), this.loggerContext);
97+
log.error($t(messages.CS_ASSETS_ASSET_UIDS_FILE_INVALID, { path: pathShown, detail: e.message }), this.loggerContext);
9898
}
9999
process.exitCode = 1;
100100
}
@@ -103,16 +103,16 @@ export default class BulkAmAssets extends BaseAmCommand {
103103
try {
104104
const f = this.parsedFlags;
105105

106-
const amBaseUrl = (this.region as RegionWithOptionalAmUrl).csAssetsUrl?.trim();
107-
if (!amBaseUrl) {
108-
log.error($t(messages.AM_URL_NOT_CONFIGURED), this.loggerContext);
106+
const csAssetsBaseUrl = (this.region as RegionWithOptionalCsAssetsUrl).csAssetsUrl?.trim();
107+
if (!csAssetsBaseUrl) {
108+
log.error($t(messages.CS_ASSETS_URL_NOT_CONFIGURED), this.loggerContext);
109109
process.exitCode = 1;
110110
return;
111111
}
112112

113113
const op = f.operation;
114114
if (op !== 'delete' && op !== 'move') {
115-
log.error($t(messages.AM_INVALID_OPERATION, { operation: String(op ?? '') }), this.loggerContext);
115+
log.error($t(messages.CS_ASSETS_INVALID_OPERATION, { operation: String(op ?? '') }), this.loggerContext);
116116
process.exitCode = 1;
117117
return;
118118
}
@@ -121,12 +121,12 @@ export default class BulkAmAssets extends BaseAmCommand {
121121
const orgUid = f['org-uid'].trim();
122122
const assetUidsPath = f['asset-uids-file'].trim();
123123

124-
let deleteRows: AmBulkDeleteItem[];
124+
let deleteRows: CsAssetsBulkDeleteItem[];
125125

126126
if (op === 'delete') {
127127
const locale = (f.locale ?? '').trim();
128128
if (!locale) {
129-
log.error($t(messages.AM_LOCALE_REQUIRED), this.loggerContext);
129+
log.error($t(messages.CS_ASSETS_LOCALE_REQUIRED), this.loggerContext);
130130
process.exitCode = 1;
131131
return;
132132
}
@@ -143,18 +143,18 @@ export default class BulkAmAssets extends BaseAmCommand {
143143
}
144144

145145
createLogContext(this.context?.info?.command || COMMAND_ID, spaceUid, 'OAuth/Token');
146-
const amService = new AmAssetService(amBaseUrl, spaceUid, orgUid);
146+
const csAssetsService = new CsAssetsService(csAssetsBaseUrl, spaceUid, orgUid);
147147
const workspace = f.workspace ?? 'main';
148148

149149
if (!f.yes) {
150150
console.log(chalk.yellow(`\n${$t(messages.OPERATION_CONFIG_HEADER)}\n`));
151-
console.log(' Operation: AM bulk delete');
151+
console.log(' Operation: CS Assets bulk delete');
152152
console.log(` Space UID: ${spaceUid}`);
153153
console.log(` Organization UID: ${orgUid}`);
154154
console.log(` Workspace: ${workspace}`);
155155
console.log(` Locale: ${locale}`);
156156
console.log(` Asset UIDs file: ${assetUidsPath}`);
157-
console.log(` Total AM delete entries: ${deleteRows.length}\n`);
157+
console.log(` Total CS Assets delete entries: ${deleteRows.length}\n`);
158158

159159
const confirmed: boolean = await cliux.inquire({
160160
type: 'confirm',
@@ -168,19 +168,19 @@ export default class BulkAmAssets extends BaseAmCommand {
168168
}
169169
}
170170

171-
log.info($t(messages.AM_DELETING_ASSETS, { count: deleteRows.length, spaceUid }), this.loggerContext);
172-
const result = await amService.bulkDelete(spaceUid, workspace, deleteRows);
171+
log.info($t(messages.CS_ASSETS_DELETING_ASSETS, { count: deleteRows.length, spaceUid }), this.loggerContext);
172+
const result = await csAssetsService.bulkDelete(spaceUid, workspace, deleteRows);
173173
if (!result.success) {
174-
this.printAmSummary('delete', { error: result.error ?? 'AM bulk delete failed', spaceUid });
174+
this.printCsAssetsSummary('delete', { error: result.error ?? 'CS Assets bulk delete failed', spaceUid });
175175
process.exitCode = 1;
176176
return;
177177
}
178-
this.printAmSummary('delete', { jobId: result.jobId, notice: result.notice, spaceUid });
178+
this.printCsAssetsSummary('delete', { jobId: result.jobId, notice: result.notice, spaceUid });
179179
return;
180180
}
181181

182182
if (f.locale) {
183-
log.error($t(messages.AM_LOCALE_NOT_ALLOWED_FOR_MOVE), this.loggerContext);
183+
log.error($t(messages.CS_ASSETS_LOCALE_NOT_ALLOWED_FOR_MOVE), this.loggerContext);
184184
process.exitCode = 1;
185185
return;
186186
}
@@ -206,12 +206,12 @@ export default class BulkAmAssets extends BaseAmCommand {
206206
}
207207

208208
createLogContext(this.context?.info?.command || COMMAND_ID, spaceUid, 'OAuth/Token');
209-
const amService = new AmAssetService(amBaseUrl, spaceUid, orgUid);
209+
const csAssetsService = new CsAssetsService(csAssetsBaseUrl, spaceUid, orgUid);
210210
const workspace = f.workspace ?? 'main';
211211

212212
if (!f.yes) {
213213
console.log(chalk.yellow(`\n${$t(messages.OPERATION_CONFIG_HEADER)}\n`));
214-
console.log(' Operation: AM bulk move');
214+
console.log(' Operation: CS Assets bulk move');
215215
console.log(` Space UID: ${spaceUid}`);
216216
console.log(` Organization UID: ${orgUid}`);
217217
console.log(` Workspace: ${workspace}`);
@@ -232,16 +232,16 @@ export default class BulkAmAssets extends BaseAmCommand {
232232
}
233233

234234
log.info(
235-
$t(messages.AM_MOVING_ASSETS, { count: uids.length, targetFolderUid: moveFolderUid }),
235+
$t(messages.CS_ASSETS_MOVING_ASSETS, { count: uids.length, targetFolderUid: moveFolderUid }),
236236
this.loggerContext
237237
);
238-
const result = await amService.bulkMove(spaceUid, workspace, uids, moveFolderUid);
238+
const result = await csAssetsService.bulkMove(spaceUid, workspace, uids, moveFolderUid);
239239
if (!result.success) {
240-
this.printAmSummary('move', { error: result.error ?? 'AM bulk move failed', spaceUid });
240+
this.printCsAssetsSummary('move', { error: result.error ?? 'CS Assets bulk move failed', spaceUid });
241241
process.exitCode = 1;
242242
return;
243243
}
244-
this.printAmSummary('move', { count: uids.length, folderUid: moveFolderUid, notice: result.notice, spaceUid });
244+
this.printCsAssetsSummary('move', { count: uids.length, folderUid: moveFolderUid, notice: result.notice, spaceUid });
245245
} catch (error) {
246246
handleAndLogError(error);
247247
}

packages/contentstack-bulk-operations/src/interfaces/index.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export enum ResourceType {
2020
ENTRY = 'entry',
2121
ASSET = 'asset',
2222
TAXONOMY = 'taxonomy',
23-
AM_ASSET = 'am-asset',
23+
CS_ASSETS = 'cs-assets',
2424
}
2525

2626
export enum FilterType {
@@ -198,7 +198,7 @@ export interface CommandFlags {
198198
// Asset-specific flags
199199
'folder-uid'?: string;
200200

201-
/** AM bulk delete/move */
201+
/** CS Assets bulk delete/move */
202202
'space-uid'?: string;
203203
'org-uid'?: string;
204204
workspace?: string;
@@ -257,22 +257,22 @@ export interface AssetPublishData {
257257
publish_details?: PublishDetails[];
258258
}
259259

260-
/** One row for AM bulk-delete payload `{ uid, locale }[]`. */
261-
export interface AmBulkDeleteItem {
260+
/** One row for CS Assets bulk-delete payload `{ uid, locale }[]`. */
261+
export interface CsAssetsBulkDeleteItem {
262262
uid: string;
263263
locale: string;
264264
}
265265

266-
/** Normalized outcome from AM bulk delete/move calls (CLI layer). */
267-
export interface AmBulkOperationResult {
266+
/** Normalized outcome from CS Assets bulk delete/move calls (CLI layer). */
267+
export interface CsAssetsBulkOperationResult {
268268
success: boolean;
269269
notice?: string;
270270
jobId?: string;
271271
error?: string;
272272
}
273273

274274
/** Typed flags for the bulk-am-assets command. */
275-
export interface AmAssetFlags {
275+
export interface CsAssetsFlags {
276276
operation: string;
277277
'space-uid': string;
278278
'org-uid': string;

0 commit comments

Comments
 (0)