Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .talismanrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
fileignoreconfig:

- filename: pnpm-lock.yaml
checksum: 2e1116588e19b058f0d6a5efa28f54c6a3af11b0f0d8c442ed9866a90b77b713
- filename: packages/contentstack-export-to-csv/test/unit/commands/export-to-csv.test.ts
Expand Down Expand Up @@ -147,4 +148,4 @@ fileignoreconfig:
checksum: de694e861560c4c242100eaf17a6d8e230247b99f94e4b428e55ef065084c10c
- filename: packages/contentstack-export/test/unit/utils/export-config-handler.test.ts
checksum: f612661a8b6784b20ea62794b35192b340a34d8424a54a1a2cffec1878ab7528
version: ""
version: ""
2 changes: 1 addition & 1 deletion packages/contentstack-apps-cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,4 @@
"app:deploy": "APDP"
}
}
}
}
5 changes: 3 additions & 2 deletions packages/contentstack-export/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,12 @@
"csdxConfig": {
"shortCommandName": {
"cm:stacks:export": "EXPRT"
}
},
"planProtectedFeatures": ["assetsScan"]
},
"repository": {
"type": "git",
"url": "git+https://github.com/contentstack/cli-plugins.git",
"directory": "packages/contentstack-export"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ export default class ExportCommand extends Command {
let exportDir: string = pathValidator('logs');
try {
const { flags } = await this.parse(ExportCommand);
const exportConfig = await setupExportConfig(flags);
const exportConfig = await setupExportConfig(flags, this.context);
// Prepare the context object
const context = this.createExportContext(exportConfig.apiKey, exportConfig.authenticationMethod);
exportConfig.context = { ...context };
Expand Down
2 changes: 2 additions & 0 deletions packages/contentstack-export/src/types/export-config.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { FeatureStatus } from '@contentstack/cli-utilities';
import { Context, Modules, Region } from '.';
import DefaultConfig from './default-config';

Expand Down Expand Up @@ -36,6 +37,7 @@ export default interface ExportConfig extends DefaultConfig {
skipDependencies?: boolean;
authenticationMethod?: string;
linkedWorkspaces?: Array<{ uid: string; space_uid: string; is_default: boolean }>;
planStatus?: Record<string, FeatureStatus>;
}

type branch = {
Expand Down
51 changes: 41 additions & 10 deletions packages/contentstack-export/src/utils/export-config-handler.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
import merge from 'merge';
import * as path from 'path';
import { configHandler, isAuthenticated, cliux, sanitizePath, log } from '@contentstack/cli-utilities';
import {
configHandler,
isAuthenticated,
cliux,
sanitizePath,
log,
assertFeatureEnabled,
FeatureCtx,
isFeatureEnabled,
} from '@contentstack/cli-utilities';
import defaultConfig from '../config';
import { readFile, isDirectoryNonEmpty } from './file-helper';
import { askExportDir, askAPIKey } from './interactive';
import login from './basic-login';
import { filter, includes } from 'lodash';
import { ExportConfig } from '../types';

const setupConfig = async (exportCmdFlags: any): Promise<ExportConfig> => {
const setupConfig = async (exportCmdFlags: any, context: any): Promise<ExportConfig> => {
// Set progress supported module FIRST, before any log calls
// This ensures the logger respects the showConsoleLogs setting correctly
configHandler.set('log.progressSupportedModule', 'export');
Expand All @@ -29,12 +38,9 @@ const setupConfig = async (exportCmdFlags: any): Promise<ExportConfig> => {
if (legacyCsAssetsConfig) {
externalConfig.modules['cs-assets'] = externalConfig.modules['cs-assets'] || legacyCsAssetsConfig;
delete externalConfig.modules['asset-management'];
log.warn(
'Config key "modules.asset-management" is deprecated. Please rename it to "modules.cs-assets".',
);
log.warn('Config key "modules.asset-management" is deprecated. Please rename it to "modules.cs-assets".');
}


config = merge.recursive(config, externalConfig);
}
config.exportDir = sanitizePath(
Expand All @@ -52,10 +58,9 @@ const setupConfig = async (exportCmdFlags: any): Promise<ExportConfig> => {
config.exportDir = path.resolve(config.exportDir);

if (isDirectoryNonEmpty(config.exportDir)) {
cliux.print(
'\nThe export directory is not empty. Existing files in this folder may be overwritten.',
{ color: 'yellow' },
);
cliux.print('\nThe export directory is not empty. Existing files in this folder may be overwritten.', {
color: 'yellow',
});
}

const managementTokenAlias = exportCmdFlags['management-token-alias'] || exportCmdFlags['alias'];
Expand Down Expand Up @@ -152,6 +157,32 @@ const setupConfig = async (exportCmdFlags: any): Promise<ExportConfig> => {
config.authenticationMethod = authenticationMethod;
log.debug('Export configuration setup completed.', { ...config });

// Deferred plan check — credentials now available after setupExportConfig
const deferredFeatures: string[] = context?.planCheckRequired ?? [];
if (deferredFeatures.length > 0) {
const planCtx: FeatureCtx = {
apiKey: config.apiKey,
managementToken: config.management_token,
authToken: config.auth_token,
};
for (const featureUid of deferredFeatures) {
try {
const status = await isFeatureEnabled(featureUid, planCtx);
if (context) {
context.planStatus[featureUid] = status;
}

log.debug(`[export] Deferred plan status fetched for "${featureUid}".`);
} catch (error) {
log.warn(`[export] Could not fetch deferred plan status for "${featureUid}": ${(error as Error).message}`);
}
}
}

if (context?.planStatus) {
config.planStatus = context.planStatus;
}

return config;
};

Expand Down
6 changes: 4 additions & 2 deletions packages/contentstack-import/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,13 @@
"csdxConfig": {
"shortCommandName": {
"cm:stacks:import": "IMPRT"
}
},
"planProtectedFeatures": ["assetsScan"]

},
"repository": {
"type": "git",
"url": "git+https://github.com/contentstack/cli-plugins.git",
"directory": "packages/contentstack-import"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ export default class ImportCommand extends Command {
let importConfig: ImportConfig;
try {
const { flags } = await this.parse(ImportCommand);
importConfig = await setupImportConfig(flags);
importConfig = await setupImportConfig(flags, this.context);
// Prepare the context object
createLogContext(
this.context?.info?.command || 'cm:stacks:import',
Expand Down Expand Up @@ -182,7 +182,10 @@ export default class ImportCommand extends Command {
if (importConfig.assetScanningEnabled) {
cliux.print('\nAsset Scanning is enabled — assets were not published.', { color: 'yellow' });
cliux.print(' Once scanning completes, publish your assets using:', { color: 'yellow' });
cliux.print(` csdx cm:stacks:bulk-assets --data-dir ${backupDir} --stack-api-key ${importConfig.apiKey} --operation publish`, { color: 'cyan' });
cliux.print(
` csdx cm:stacks:bulk-assets --data-dir ${backupDir} --stack-api-key ${importConfig.apiKey} --operation publish`,
{ color: 'cyan' },
);
}
this.logSuccessAndBackupMessages(backupDir, importConfig);
// Clear progress module setting now that import is complete
Expand Down
6 changes: 0 additions & 6 deletions packages/contentstack-import/src/import/module-importer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,6 @@ class ModuleImporter {
const stackDetails: Record<string, unknown> = await this.stackAPIClient.fetch();
this.importConfig.stackName = stackDetails.name as string;
this.importConfig.org_uid = stackDetails.org_uid as string;

const assetScanningEnabled = await this.detectAssetScanning(this.importConfig.org_uid);
if (assetScanningEnabled) {
this.importConfig.assetScanningEnabled = true;
this.importConfig.skipAssetsPublish = true;
}
}

await this.resolveImportPath();
Expand Down
19 changes: 14 additions & 5 deletions packages/contentstack-import/src/import/modules/assets.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import uniq from 'lodash/uniq';
import { existsSync } from 'node:fs';
import includes from 'lodash/includes';
import { resolve as pResolve, join } from 'node:path';
import { FsUtility, log, handleAndLogError, generateUid } from '@contentstack/cli-utilities';
import { FsUtility, log, handleAndLogError, generateUid, FeatureStatus } from '@contentstack/cli-utilities';
import { ImportSpaces, type SpaceMapping } from '@contentstack/cli-asset-management';
import { PATH_CONSTANTS } from '../../constants';

Expand Down Expand Up @@ -39,11 +39,13 @@ export default class ImportAssets extends BaseClass {
private assetsUrlMap: Record<string, unknown> = {};
private assetsFolderMap: Record<string, unknown> = {};
private rootFolder: { uid: string; name: string; parent_uid: string; created_at: string };
private planStatus: Record<string, FeatureStatus> = {};

constructor({ importConfig, stackAPIClient }: ModuleClassParams) {
super({ importConfig, stackAPIClient });
this.importConfig.context.module = MODULE_CONTEXTS.ASSETS;
this.currentModuleName = MODULE_NAMES[MODULE_CONTEXTS.ASSETS];
this.planStatus = this.importConfig.planStatus || {};

this.assetsPath = join(this.importConfig.backupDir, PATH_CONSTANTS.CONTENT_DIRS.ASSETS);
this.mapperDirPath = join(this.importConfig.backupDir, PATH_CONSTANTS.MAPPER, PATH_CONSTANTS.MAPPER_MODULES.ASSETS);
Expand All @@ -66,6 +68,10 @@ export default class ImportAssets extends BaseClass {
try {
log.debug('Starting assets import process...', this.importConfig.context);

if (this.planStatus['assetsScan']?.is_part_of_plan) {
log.info('Assets Scanning is enabled in this stack', this.importConfig.context);
log.warn('Assets publishing will be skipped', this.importConfig.context);
}
// CS Assets: csAssetsEnabled is set in the config handler when spaces/ + am_v2 are detected.
if (this.importConfig.csAssetsEnabled) {
if (!this.importConfig.csAssetsUrl) {
Expand Down Expand Up @@ -199,10 +205,13 @@ export default class ImportAssets extends BaseClass {
log.success('Assets imported successfully!', this.importConfig.context);

if (this.importConfig.assetScanningEnabled) {
log.info(' Asset Scanning is enabled for this stack.', this.importConfig.context);
log.info(' Assets cannot be published immediately — scanning must complete first.', this.importConfig.context);
log.info(' Once scanning is done, publish your assets using:', this.importConfig.context);
log.info(' csdx cm:stacks:bulk-assets --data-dir ./content --stack-api-key <key> --operation publish', this.importConfig.context);
log.info('Asset Scanning is enabled for this stack.', this.importConfig.context);
log.info('Assets cannot be published immediately — scanning must complete first.', this.importConfig.context);
log.info('Once scanning is done, publish your assets using:', this.importConfig.context);
log.info(
'csdx cm:stacks:bulk-assets --data-dir ./content --stack-api-key <key> --operation publish',
this.importConfig.context,
);
}
} catch (error) {
this.completeProgress(false, error?.message || 'Asset import failed');
Expand Down
2 changes: 2 additions & 0 deletions packages/contentstack-import/src/types/import-config.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { FeatureStatus } from '@contentstack/cli-utilities';
import { Context, Modules, Region } from '.';
import DefaultConfig from './default-config';

Expand Down Expand Up @@ -61,6 +62,7 @@ export default interface ImportConfig extends DefaultConfig, ExternalConfig {
context: Context;
csAssetsUrl?: string;
csAssetsEnabled?: boolean;
planStatus?: Record<string, FeatureStatus>;
}

type branch = {
Expand Down
39 changes: 37 additions & 2 deletions packages/contentstack-import/src/utils/import-config-handler.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
import merge from 'merge';
import * as path from 'path';
import { omit, filter, includes, isArray } from 'lodash';
import { configHandler, isAuthenticated, cliux, sanitizePath, log } from '@contentstack/cli-utilities';
import {
configHandler,
isAuthenticated,
cliux,
sanitizePath,
log,
isFeatureEnabled,
FeatureCtx,
} from '@contentstack/cli-utilities';
import defaultConfig from '../config';
import { readFile, readFileSync } from './file-helper';
import { askContentDir, askAPIKey } from './interactive';
import login from './login-handler';
import { ImportConfig } from '../types';
import { existsSync } from 'fs';

const setupConfig = async (importCmdFlags: any): Promise<ImportConfig> => {
const setupConfig = async (importCmdFlags: any, context?: any): Promise<ImportConfig> => {
// Set progress supported module FIRST, before any log calls
// This ensures the logger respects the showConsoleLogs setting correctly
configHandler.set('log.progressSupportedModule', 'import');
Expand Down Expand Up @@ -167,6 +175,33 @@ const setupConfig = async (importCmdFlags: any): Promise<ImportConfig> => {
config.authenticationMethod = authenticationMethod;
log.debug('Import configuration setup completed.', { ...config });

// Deferred plan check — credentials now available after setupImportConfig
const deferredFeatures: string[] = context?.planCheckRequired ?? [];
if (deferredFeatures.length > 0) {
const planCtx: FeatureCtx = {
apiKey: config.apiKey,
managementToken: config.management_token,
authToken: config.auth_token,
};
for (const featureUid of deferredFeatures) {
try {
const status = await isFeatureEnabled(featureUid, planCtx);
if (context) context.planStatus[featureUid] = status;
log.debug(`[import] Deferred plan status fetched for "${featureUid}".`);
} catch (error) {
log.warn(`[import] Could not fetch deferred plan status for "${featureUid}": ${(error as Error).message}`);
}
}
}

if (context?.planStatus) {
config.planStatus = context.planStatus;
if (config.planStatus['assetsScan']?.is_part_of_plan) {
config.assetScanningEnabled = true;
config.skipAssetsPublish = true;
}
}

return config;
};

Expand Down
Loading
Loading