Skip to content
Draft
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
8 changes: 6 additions & 2 deletions .talismanrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
fileignoreconfig:
- filename: pnpm-lock.yaml
checksum: 24619b075664a197c8f648b04dd86ee79d653fbb583b33e4a3768f02378912ef
- filename: pnpm-lock.yaml
checksum: 24619b075664a197c8f648b04dd86ee79d653fbb583b33e4a3768f02378912ef
- filename: packages/contentstack-import/src/utils/import-config-handler.ts
checksum: 25b986edf20dfd555f9ffc6f124d7d6eb7ac1134a5a67224a49ba48aa50b86f3
- filename: packages/contentstack-export/src/utils/export-config-handler.ts
checksum: a024cdb82e21496794f49fd905f983c0d6677ac9d6761f2e46266fea9932041d
version: '1.0'
4 changes: 2 additions & 2 deletions packages/contentstack-export/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"bugs": "https://github.com/contentstack/cli/issues",
"dependencies": {
"@contentstack/cli-command": "~2.0.0-beta.8",
"@contentstack/cli-utilities": "~2.0.0-beta.9",
"@contentstack/cli-utilities": "~2.0.0-beta.10",
"@contentstack/cli-variants": "~2.0.0-beta.16",
"@contentstack/cli-asset-management": "~1.0.0-beta.4",
"@oclif/core": "^4.11.4",
Expand Down Expand Up @@ -99,4 +99,4 @@
}
},
"repository": "https://github.com/contentstack/cli"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ import { Context, ExportConfig } from '../../../types';
import { setupExportConfig } from '../../../utils';

export default class ExportCommand extends Command {
static planProtectedFeatures = ['assetsScan'];

static description: string = messageHandler.parse('Export content from a stack');

static examples: string[] = [
Expand Down Expand Up @@ -92,7 +94,8 @@ 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
44 changes: 34 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,25 @@ 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}`);
}
}
}

return config;
};

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"root":["./src/index.ts","./src/adapters/registry.ts","./src/adapters/types.ts","./src/adapters/contentful/convert.ts","./src/adapters/contentful/export.ts","./src/adapters/contentful/index.ts","./src/adapters/contentful/validator.ts","./src/commands/external-migrate/audit.ts","./src/commands/external-migrate/convert.ts","./src/commands/external-migrate/create.ts","./src/commands/external-migrate/export.ts","./src/commands/external-migrate/import.ts","./src/commands/external-migrate/status.ts","./src/lib/bundle.ts","./src/lib/clear-import-state.ts","./src/lib/contentful-cli-spawn.ts","./src/lib/conversion-summary.ts","./src/lib/create-stack.ts","./src/lib/csdx-spawn.ts","./src/lib/local-date.ts","./src/lib/log.ts","./src/lib/manifest.ts","./src/lib/parse-json-loose.ts","./src/services/contentful/config.ts","./src/services/contentful/constants.ts","./src/services/contentful/content-type-creator.ts","./src/services/contentful/contentful.service.ts","./src/services/contentful/extension.service.ts","./src/services/contentful/market-app.utils.ts","./src/services/contentful/marketplace.service.ts","./src/services/contentful/releases.ts","./src/services/contentful/scheduled.ts","./src/services/contentful/tasks.ts","./src/services/contentful/types.ts","./src/services/contentful/users.ts","./src/services/contentful/workflows.ts","./src/services/contentful/contentful/jsonrte.ts","./src/services/contentful/contentful/markdown.ts","./src/services/contentful/contentful/roles.ts","./src/services/contentful/contentful/taxonomy.service.ts","./src/services/contentful/mapper/write.ts","./src/services/contentful/migration-contentful/index.js","./src/services/contentful/migration-contentful/libs/contenttypemapper.js","./src/services/contentful/migration-contentful/libs/createinitialmapper.js","./src/services/contentful/migration-contentful/libs/extractcontenttypes.js","./src/services/contentful/migration-contentful/libs/extractlocale.js","./src/services/contentful/migration-contentful/libs/extracttaxonomy.js","./src/services/contentful/migration-contentful/utils/helper.js","./src/services/contentful/prompts/master-locale.ts","./src/services/contentful/utils/custom-logger.utils.ts","./src/services/contentful/utils/index.ts"],"version":"5.9.3"}
{"root":["./src/index.ts","./src/adapters/registry.ts","./src/adapters/types.ts","./src/adapters/contentful/convert.ts","./src/adapters/contentful/export.ts","./src/adapters/contentful/index.ts","./src/adapters/contentful/validator.ts","./src/commands/migrate/audit.ts","./src/commands/migrate/convert.ts","./src/commands/migrate/create.ts","./src/commands/migrate/export.ts","./src/commands/migrate/import.ts","./src/commands/migrate/status.ts","./src/lib/bundle.ts","./src/lib/clear-import-state.ts","./src/lib/contentful-cli-spawn.ts","./src/lib/conversion-summary.ts","./src/lib/create-stack.ts","./src/lib/csdx-spawn.ts","./src/lib/local-date.ts","./src/lib/log.ts","./src/lib/manifest.ts","./src/lib/parse-json-loose.ts","./src/services/contentful/config.ts","./src/services/contentful/constants.ts","./src/services/contentful/content-type-creator.ts","./src/services/contentful/contentful.service.ts","./src/services/contentful/extension.service.ts","./src/services/contentful/market-app.utils.ts","./src/services/contentful/marketplace.service.ts","./src/services/contentful/releases.ts","./src/services/contentful/scheduled.ts","./src/services/contentful/tasks.ts","./src/services/contentful/types.ts","./src/services/contentful/users.ts","./src/services/contentful/workflows.ts","./src/services/contentful/contentful/jsonrte.ts","./src/services/contentful/contentful/markdown.ts","./src/services/contentful/contentful/roles.ts","./src/services/contentful/contentful/taxonomy.service.ts","./src/services/contentful/mapper/write.ts","./src/services/contentful/migration-contentful/index.js","./src/services/contentful/migration-contentful/libs/contenttypemapper.js","./src/services/contentful/migration-contentful/libs/createinitialmapper.js","./src/services/contentful/migration-contentful/libs/extractcontenttypes.js","./src/services/contentful/migration-contentful/libs/extractlocale.js","./src/services/contentful/migration-contentful/libs/extracttaxonomy.js","./src/services/contentful/migration-contentful/utils/helper.js","./src/services/contentful/prompts/master-locale.ts","./src/services/contentful/utils/custom-logger.utils.ts","./src/services/contentful/utils/index.ts"],"version":"5.9.3"}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { expect } from 'chai';
import * as path from 'path';
import * as os from 'os';
import * as fs from 'fs';
import { stub, restore, SinonStub } from 'sinon';
import { stub, restore, SinonStub, createSandbox } from 'sinon';
import * as utilities from '@contentstack/cli-utilities';
import * as cliAm from '@contentstack/cli-asset-management';
import setupConfig from '../../src/utils/import-config-handler';
Expand Down Expand Up @@ -153,11 +153,13 @@ describe('Import Config Handler', () => {
});

it('should merge Asset Management export flags from detectAssetManagementExportFromContentDir into config', async () => {
const detectStub = stub(cliAm, 'detectAssetManagementExportFromContentDir').returns({
const sandbox = createSandbox();
const detectFake = sandbox.fake.returns({
assetManagementEnabled: true,
source_stack: 'branch-source-key',
assetManagementUrl: 'https://am.example.com',
});
sandbox.replaceGetter(cliAm, 'detectAssetManagementExportFromContentDir', () => detectFake);

try {
const config = await setupConfig({
Expand All @@ -166,12 +168,12 @@ describe('Import Config Handler', () => {
module: ['assets'],
});

expect(detectStub.calledOnce).to.be.true;
expect(config.assetManagementEnabled).to.equal(true);
expect(config.assetManagementUrl).to.equal('https://am.example.com');
expect(detectFake.calledOnce).to.be.true;
expect(config.csAssetsEnabled).to.equal(true);
expect(config.csAssetsUrl).to.equal('https://am.example.com');
expect(config.source_stack).to.equal('branch-source-key');
} finally {
detectStub.restore();
sandbox.restore();
}
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -200,12 +200,12 @@ describe('AssetImportSetup Asset Management export', () => {
backupDir,
region: {
cma: 'https://api.contentstack.io/v3',
assetManagementUrl: 'https://am.example.com',
csAssetsUrl: 'https://am.example.com',
},
host: 'https://api.contentstack.io/v3',
fetchConcurrency: 2,
writeConcurrency: 1,
assetManagementEnabled: true,
csAssetsEnabled: true,
org_uid: 'org-uid-test',
source_stack: 'source-api-key',
context: {},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ import { ModuleImporter } from '../../../import';
import { setupImportConfig } from '../../../utils';

export default class ImportCommand extends Command {
static planProtectedFeatures = ['assetsScan'];

static description = messageHandler.parse('Import content from a stack');

static examples: string[] = [
Expand Down Expand Up @@ -124,7 +126,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
23 changes: 21 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,15 @@
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 @@ -166,6 +166,25 @@ 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}`);
}
}
}

return config;
};

Expand Down