@contentstack/cli-audit 1.17.0 → 2.0.0-beta

package/lib/modules/composable-studio.d.ts

@@ -1,40 +0,0 @@
-import { ConfigType, ContentTypeStruct, CtConstructorParam, ModuleConstructorParam } from '../types';
-import auditConfig from '../config';
-import { ComposableStudioProject } from '../types/composable-studio';
-export default class ComposableStudio {
-    protected fix: boolean;
-    fileName: string;
-    config: ConfigType;
-    folderPath: string;
-    composableStudioProjects: ComposableStudioProject[];
-    ctSchema: ContentTypeStruct[];
-    moduleName: keyof typeof auditConfig.moduleConfig;
-    ctUidSet: Set<string>;
-    environmentUidSet: Set<string>;
-    localeCodeSet: Set<string>;
-    projectsWithIssues: any[];
-    composableStudioPath: string;
-    private projectsWithIssuesMap;
-    constructor({ fix, config, moduleName, ctSchema }: ModuleConstructorParam & Pick<CtConstructorParam, 'ctSchema'>);
-    validateModules(moduleName: keyof typeof auditConfig.moduleConfig, moduleConfig: Record<string, unknown>): keyof typeof auditConfig.moduleConfig;
-    /**
-     * Load environments from the environments.json file
-     */
-    loadEnvironments(): Promise<void>;
-    /**
-     * Load locales from the locales.json and master-locale.json files
-     */
-    loadLocales(): Promise<void>;
-    /**
-     * Main run method to audit composable studio projects
-     */
-    run(): Promise<{}>;
-    /**
-     * Fix composable studio projects by removing invalid references
-     */
-    fixComposableStudioProjects(): Promise<void>;
-    /**
-     * Write fixed composable studio projects back to file
-     */
-    writeFixContent(fixedProjects: any): Promise<void>;
-}

package/lib/modules/composable-studio.js

@@ -1,307 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
-const fs_1 = require("fs");
-const cli_utilities_1 = require("@contentstack/cli-utilities");
-const messages_1 = require("../messages");
-class ComposableStudio {
-    constructor({ fix, config, moduleName, ctSchema }) {
-        this.config = config;
-        this.fix = fix !== null && fix !== void 0 ? fix : false;
-        this.ctSchema = ctSchema;
-        this.composableStudioProjects = [];
-        cli_utilities_1.log.debug(`Initializing ComposableStudio module`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Fix mode: ${this.fix}`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Content types count: ${ctSchema.length}`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Module name: ${moduleName}`, this.config.auditContext);
-        this.moduleName = this.validateModules(moduleName, this.config.moduleConfig);
-        this.fileName = config.moduleConfig[this.moduleName].fileName;
-        cli_utilities_1.log.debug(`File name: ${this.fileName}`, this.config.auditContext);
-        this.folderPath = (0, path_1.resolve)((0, cli_utilities_1.sanitizePath)(config.basePath), (0, cli_utilities_1.sanitizePath)(config.moduleConfig[this.moduleName].dirName));
-        cli_utilities_1.log.debug(`Folder path: ${this.folderPath}`, this.config.auditContext);
-        this.ctUidSet = new Set();
-        this.environmentUidSet = new Set();
-        this.localeCodeSet = new Set();
-        this.projectsWithIssues = [];
-        this.projectsWithIssuesMap = new Map();
-        this.composableStudioPath = '';
-        cli_utilities_1.log.debug(`ComposableStudio module initialization completed`, this.config.auditContext);
-    }
-    validateModules(moduleName, moduleConfig) {
-        cli_utilities_1.log.debug(`Validating module: ${moduleName}`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Available modules: ${Object.keys(moduleConfig).join(', ')}`, this.config.auditContext);
-        if (Object.keys(moduleConfig).includes(moduleName)) {
-            cli_utilities_1.log.debug(`Module ${moduleName} is valid`, this.config.auditContext);
-            return moduleName;
-        }
-        cli_utilities_1.log.debug(`Module ${moduleName} not found, defaulting to 'composable-studio'`, this.config.auditContext);
-        return 'composable-studio';
-    }
-    /**
-     * Load environments from the environments.json file
-     */
-    async loadEnvironments() {
-        cli_utilities_1.log.debug(`Loading environments`, this.config.auditContext);
-        const environmentsPath = (0, path_1.resolve)(this.config.basePath, 'environments', 'environments.json');
-        if ((0, fs_1.existsSync)(environmentsPath)) {
-            cli_utilities_1.log.debug(`Environments file path: ${environmentsPath}`, this.config.auditContext);
-            try {
-                const environments = JSON.parse((0, fs_1.readFileSync)(environmentsPath, 'utf-8'));
-                const envArray = Array.isArray(environments) ? environments : Object.values(environments);
-                envArray.forEach((env) => {
-                    if (env.uid) {
-                        this.environmentUidSet.add(env.uid);
-                    }
-                });
-                cli_utilities_1.log.debug(`Loaded ${this.environmentUidSet.size} environments: ${Array.from(this.environmentUidSet).join(', ')}`, this.config.auditContext);
-            }
-            catch (error) {
-                (0, cli_utilities_1.handleAndLogError)(error, this.config.auditContext, 'Failed to load environments');
-            }
-        }
-        else {
-            cli_utilities_1.log.debug(`Environments file not found at: ${environmentsPath}`, this.config.auditContext);
-        }
-    }
-    /**
-     * Load locales from the locales.json and master-locale.json files
-     */
-    async loadLocales() {
-        cli_utilities_1.log.debug(`Loading locales`, this.config.auditContext);
-        const localesPath = (0, path_1.resolve)(this.config.basePath, 'locales', 'locales.json');
-        const masterLocalePath = (0, path_1.resolve)(this.config.basePath, 'locales', 'master-locale.json');
-        // Load master locale
-        if ((0, fs_1.existsSync)(masterLocalePath)) {
-            cli_utilities_1.log.debug(`Master locale file path: ${masterLocalePath}`, this.config.auditContext);
-            try {
-                const masterLocales = JSON.parse((0, fs_1.readFileSync)(masterLocalePath, 'utf-8'));
-                const localeArray = Array.isArray(masterLocales) ? masterLocales : Object.values(masterLocales);
-                localeArray.forEach((locale) => {
-                    if (locale.code) {
-                        this.localeCodeSet.add(locale.code);
-                    }
-                });
-                cli_utilities_1.log.debug(`Loaded ${this.localeCodeSet.size} master locales`, this.config.auditContext);
-            }
-            catch (error) {
-                (0, cli_utilities_1.handleAndLogError)(error, this.config.auditContext, 'Failed to load master locales');
-            }
-        }
-        else {
-            cli_utilities_1.log.debug(`Master locale file not found at: ${masterLocalePath}`, this.config.auditContext);
-        }
-        // Load additional locales
-        if ((0, fs_1.existsSync)(localesPath)) {
-            cli_utilities_1.log.debug(`Locales file path: ${localesPath}`, this.config.auditContext);
-            try {
-                const locales = JSON.parse((0, fs_1.readFileSync)(localesPath, 'utf-8'));
-                const localeArray = Array.isArray(locales) ? locales : Object.values(locales);
-                localeArray.forEach((locale) => {
-                    if (locale.code) {
-                        this.localeCodeSet.add(locale.code);
-                    }
-                });
-                cli_utilities_1.log.debug(`Total locales after loading additional locales: ${this.localeCodeSet.size}`, this.config.auditContext);
-            }
-            catch (error) {
-                (0, cli_utilities_1.handleAndLogError)(error, this.config.auditContext, 'Failed to load additional locales');
-            }
-        }
-        else {
-            cli_utilities_1.log.debug(`Locales file not found at: ${localesPath}`, this.config.auditContext);
-        }
-        cli_utilities_1.log.debug(`Locale codes loaded: ${Array.from(this.localeCodeSet).join(', ')}`, this.config.auditContext);
-    }
-    /**
-     * Main run method to audit composable studio projects
-     */
-    async run() {
-        var _a, _b, _c, _d;
-        cli_utilities_1.log.debug(`Starting ${this.moduleName} audit process`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Composable Studio folder path: ${this.folderPath}`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Fix mode: ${this.fix}`, this.config.auditContext);
-        if (!(0, fs_1.existsSync)(this.folderPath)) {
-            cli_utilities_1.log.debug(`Skipping ${this.moduleName} audit - path does not exist`, this.config.auditContext);
-            cli_utilities_1.log.warn(`Skipping ${this.moduleName} audit`, this.config.auditContext);
-            cli_utilities_1.cliux.print((0, messages_1.$t)(messages_1.auditMsg.NOT_VALID_PATH, { path: this.folderPath }), { color: 'yellow' });
-            return {};
-        }
-        this.composableStudioPath = (0, path_1.join)(this.folderPath, this.fileName);
-        cli_utilities_1.log.debug(`Composable Studio file path: ${this.composableStudioPath}`, this.config.auditContext);
-        // Load composable studio projects
-        cli_utilities_1.log.debug(`Loading composable studio projects from file`, this.config.auditContext);
-        if ((0, fs_1.existsSync)(this.composableStudioPath)) {
-            try {
-                const projectsData = JSON.parse((0, fs_1.readFileSync)(this.composableStudioPath, 'utf-8'));
-                this.composableStudioProjects = Array.isArray(projectsData) ? projectsData : [projectsData];
-                cli_utilities_1.log.debug(`Loaded ${this.composableStudioProjects.length} composable studio projects`, this.config.auditContext);
-            }
-            catch (error) {
-                (0, cli_utilities_1.handleAndLogError)(error, this.config.auditContext, 'Failed to load composable studio projects');
-                return {};
-            }
-        }
-        else {
-            cli_utilities_1.log.debug(`Composable studio file not found`, this.config.auditContext);
-            return {};
-        }
-        // Build content type UID set
-        cli_utilities_1.log.debug(`Building content type UID set from ${this.ctSchema.length} content types`, this.config.auditContext);
-        this.ctSchema.forEach((ct) => this.ctUidSet.add(ct.uid));
-        cli_utilities_1.log.debug(`Content type UID set contains: ${Array.from(this.ctUidSet).join(', ')}`, this.config.auditContext);
-        // Load environments and locales
-        await this.loadEnvironments();
-        await this.loadLocales();
-        // Process each project
-        cli_utilities_1.log.debug(`Processing ${this.composableStudioProjects.length} composable studio projects`, this.config.auditContext);
-        for (const project of this.composableStudioProjects) {
-            const { name, uid, contentTypeUid, settings } = project;
-            cli_utilities_1.log.debug(`Processing composable studio project: ${name} (${uid})`, this.config.auditContext);
-            cli_utilities_1.log.debug(`Content type UID: ${contentTypeUid}`, this.config.auditContext);
-            cli_utilities_1.log.debug(`Environment: ${(_a = settings === null || settings === void 0 ? void 0 : settings.configuration) === null || _a === void 0 ? void 0 : _a.environment}`, this.config.auditContext);
-            cli_utilities_1.log.debug(`Locale: ${(_b = settings === null || settings === void 0 ? void 0 : settings.configuration) === null || _b === void 0 ? void 0 : _b.locale}`, this.config.auditContext);
-            let hasIssues = false;
-            const issuesList = [];
-            const invalidContentTypes = [];
-            const invalidEnvironments = [];
-            const invalidLocales = [];
-            // Check content type
-            if (contentTypeUid && !this.ctUidSet.has(contentTypeUid)) {
-                cli_utilities_1.log.debug(`Content type ${contentTypeUid} not found in project ${name}`, this.config.auditContext);
-                invalidContentTypes.push(contentTypeUid);
-                issuesList.push(`Invalid contentTypeUid: ${contentTypeUid}`);
-                hasIssues = true;
-            }
-            // Check environment
-            if (((_c = settings === null || settings === void 0 ? void 0 : settings.configuration) === null || _c === void 0 ? void 0 : _c.environment) && !this.environmentUidSet.has(settings.configuration.environment)) {
-                cli_utilities_1.log.debug(`Environment ${settings.configuration.environment} not found in project ${name}`, this.config.auditContext);
-                invalidEnvironments.push(settings.configuration.environment);
-                issuesList.push(`Invalid environment: ${settings.configuration.environment}`);
-                hasIssues = true;
-            }
-            // Check locale
-            if (((_d = settings === null || settings === void 0 ? void 0 : settings.configuration) === null || _d === void 0 ? void 0 : _d.locale) && !this.localeCodeSet.has(settings.configuration.locale)) {
-                cli_utilities_1.log.debug(`Locale ${settings.configuration.locale} not found in project ${name}`, this.config.auditContext);
-                invalidLocales.push(settings.configuration.locale);
-                issuesList.push(`Invalid locale: ${settings.configuration.locale}`);
-                hasIssues = true;
-            }
-            if (hasIssues) {
-                cli_utilities_1.log.debug(`Project ${name} has validation issues`, this.config.auditContext);
-                // Store the original project for fixing
-                this.projectsWithIssuesMap.set(uid, project);
-                // Create a report-friendly object
-                const reportEntry = {
-                    title: name,
-                    name: name,
-                    uid: uid,
-                    content_types: invalidContentTypes.length > 0 ? invalidContentTypes : undefined,
-                    environment: invalidEnvironments.length > 0 ? invalidEnvironments : undefined,
-                    locale: invalidLocales.length > 0 ? invalidLocales : undefined,
-                    issues: issuesList.join(', '),
-                };
-                this.projectsWithIssues.push(reportEntry);
-            }
-            else {
-                cli_utilities_1.log.debug(`Project ${name} has no validation issues`, this.config.auditContext);
-            }
-            cli_utilities_1.log.info((0, messages_1.$t)(messages_1.auditMsg.SCAN_CS_SUCCESS_MSG, {
-                name,
-                uid,
-            }), this.config.auditContext);
-        }
-        cli_utilities_1.log.debug(`Composable Studio audit completed. Found ${this.projectsWithIssues.length} projects with issues`, this.config.auditContext);
-        if (this.fix && this.projectsWithIssues.length) {
-            cli_utilities_1.log.debug(`Fix mode enabled, fixing ${this.projectsWithIssues.length} projects`, this.config.auditContext);
-            await this.fixComposableStudioProjects();
-            this.projectsWithIssues.forEach((project) => {
-                cli_utilities_1.log.debug(`Marking project ${project.name} as fixed`, this.config.auditContext);
-                project.fixStatus = 'Fixed';
-            });
-            cli_utilities_1.log.debug(`Composable Studio fix completed`, this.config.auditContext);
-            return this.projectsWithIssues;
-        }
-        cli_utilities_1.log.debug(`Composable Studio audit completed without fixes`, this.config.auditContext);
-        return this.projectsWithIssues;
-    }
-    /**
-     * Fix composable studio projects by removing invalid references
-     */
-    async fixComposableStudioProjects() {
-        var _a, _b, _c, _d;
-        cli_utilities_1.log.debug(`Starting composable studio projects fix`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Loading current composable studio projects from: ${this.composableStudioPath}`, this.config.auditContext);
-        let projectsData;
-        try {
-            projectsData = JSON.parse((0, fs_1.readFileSync)(this.composableStudioPath, 'utf-8'));
-        }
-        catch (error) {
-            cli_utilities_1.log.debug(`Failed to load composable studio projects for fixing: ${error}`, this.config.auditContext);
-            return;
-        }
-        const isArray = Array.isArray(projectsData);
-        const projects = isArray ? projectsData : [projectsData];
-        cli_utilities_1.log.debug(`Loaded ${projects.length} projects for fixing`, this.config.auditContext);
-        for (let i = 0; i < projects.length; i++) {
-            const project = projects[i];
-            const { uid, name } = project;
-            cli_utilities_1.log.debug(`Fixing project: ${name} (${uid})`, this.config.auditContext);
-            let needsFix = false;
-            // Check and fix content type
-            if (project.contentTypeUid && !this.ctUidSet.has(project.contentTypeUid)) {
-                cli_utilities_1.log.debug(`Removing invalid content type ${project.contentTypeUid} from project ${name}`, this.config.auditContext);
-                cli_utilities_1.cliux.print(`Warning: Project "${name}" has invalid content type "${project.contentTypeUid}". It will be removed.`, { color: 'yellow' });
-                project.contentTypeUid = undefined;
-                needsFix = true;
-            }
-            // Check and fix environment
-            if (((_b = (_a = project.settings) === null || _a === void 0 ? void 0 : _a.configuration) === null || _b === void 0 ? void 0 : _b.environment) &&
-                !this.environmentUidSet.has(project.settings.configuration.environment)) {
-                cli_utilities_1.log.debug(`Removing invalid environment ${project.settings.configuration.environment} from project ${name}`, this.config.auditContext);
-                cli_utilities_1.cliux.print(`Warning: Project "${name}" has invalid environment "${project.settings.configuration.environment}". It will be removed.`, { color: 'yellow' });
-                project.settings.configuration.environment = undefined;
-                needsFix = true;
-            }
-            // Check and fix locale
-            if (((_d = (_c = project.settings) === null || _c === void 0 ? void 0 : _c.configuration) === null || _d === void 0 ? void 0 : _d.locale) && !this.localeCodeSet.has(project.settings.configuration.locale)) {
-                cli_utilities_1.log.debug(`Removing invalid locale ${project.settings.configuration.locale} from project ${name}`, this.config.auditContext);
-                cli_utilities_1.cliux.print(`Warning: Project "${name}" has invalid locale "${project.settings.configuration.locale}". It will be removed.`, { color: 'yellow' });
-                project.settings.configuration.locale = undefined;
-                needsFix = true;
-            }
-            if (needsFix) {
-                cli_utilities_1.log.debug(`Project ${name} was fixed`, this.config.auditContext);
-            }
-            else {
-                cli_utilities_1.log.debug(`Project ${name} did not need fixing`, this.config.auditContext);
-            }
-        }
-        cli_utilities_1.log.debug(`Composable studio projects fix completed, writing updated file`, this.config.auditContext);
-        await this.writeFixContent(isArray ? projects : projects[0]);
-    }
-    /**
-     * Write fixed composable studio projects back to file
-     */
-    async writeFixContent(fixedProjects) {
-        var _a, _b;
-        cli_utilities_1.log.debug(`Writing fix content`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Fix mode: ${this.fix}`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Copy directory flag: ${this.config.flags['copy-dir']}`, this.config.auditContext);
-        cli_utilities_1.log.debug(`External config skip confirm: ${(_a = this.config.flags['external-config']) === null || _a === void 0 ? void 0 : _a.skipConfirm}`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Yes flag: ${this.config.flags.yes}`, this.config.auditContext);
-        if (this.fix &&
-            (this.config.flags['copy-dir'] ||
-                ((_b = this.config.flags['external-config']) === null || _b === void 0 ? void 0 : _b.skipConfirm) ||
-                this.config.flags.yes ||
-                (await cli_utilities_1.cliux.confirm(messages_1.commonMsg.FIX_CONFIRMATION)))) {
-            const outputPath = (0, path_1.join)(this.folderPath, this.config.moduleConfig[this.moduleName].fileName);
-            cli_utilities_1.log.debug(`Writing fixed composable studio projects to: ${outputPath}`, this.config.auditContext);
-            (0, fs_1.writeFileSync)(outputPath, JSON.stringify(fixedProjects, null, 2));
-            cli_utilities_1.log.debug(`Successfully wrote fixed composable studio projects to file`, this.config.auditContext);
-        }
-        else {
-            cli_utilities_1.log.debug(`Skipping file write - fix mode disabled or user declined confirmation`, this.config.auditContext);
-        }
-    }
-}
-exports.default = ComposableStudio;

package/lib/types/composable-studio.d.ts

@@ -1,25 +0,0 @@
-interface ComposableStudioProject {
-    name: string;
-    description?: string;
-    canvasUrl?: string;
-    connectedStackApiKey?: string;
-    contentTypeUid: string;
-    organizationUid?: string;
-    settings: {
-        configuration: {
-            environment: string;
-            locale: string;
-        };
-    };
-    createdBy?: string;
-    updatedBy?: string;
-    deletedAt?: boolean;
-    createdAt?: string;
-    updatedAt?: string;
-    uid: string;
-    missingContentType?: boolean;
-    missingEnvironment?: boolean;
-    missingLocale?: boolean;
-    fixStatus?: string;
-}
-export { ComposableStudioProject };

package/lib/types/composable-studio.js

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