tnp 21.0.192 → 21.0.196

package/lib-esm/lib/project/abstract/taonJson.js

@@ -0,0 +1,687 @@
+import { crossPlatformPath, fileName, LibTypeEnum, UtilsJson, } from 'tnp-core/lib';
+import { os } from 'tnp-core/lib';
+import { Helpers, _ } from 'tnp-core/lib';
+import { Utils } from 'tnp-core/lib';
+import { BaseFeatureForProject, BasePackageJson, UtilsNpm, } from 'tnp-helpers/lib';
+import { OVERRIDE_FROM_TNP, packageJsonMainProject, scriptsCommands, taonJsonMainProject, } from '../../constants';
+import { EnvOptions } from '../../options';
+// @ts-ignore TODO weird inheritance problem
+export class TaonJson extends BaseFeatureForProject {
+    project;
+    defaultValue;
+    data;
+    /**
+     * package.json override
+     */
+    overridePackageJsonManager;
+    get path() {
+        return this.project.pathFor(fileName.taon_jsonc);
+    }
+    //#region constructor
+    //#region @backend
+    constructor(project, defaultValue) {
+        super(project);
+        this.project = project;
+        this.defaultValue = defaultValue;
+        this.project = project;
+        this.defaultValue = defaultValue;
+        this.readFromdisk(project.pathFor(taonJsonMainProject));
+    }
+    //#endregion
+    readFromdisk(pathToTaonJson, reloading = false) {
+        //#region @backendFunc
+        const defaultValue = this.defaultValue;
+        try {
+            // @ts-expect-error
+            this.data = Helpers.readJson5(pathToTaonJson);
+            if (!this.data && defaultValue) {
+                // @ts-expect-error
+                this.data = _.cloneDeep(defaultValue);
+            }
+            // @ts-expect-error
+            this.overridePackageJsonManager = new BasePackageJson({
+                jsonContent: this.data.packageJsonOverride || {},
+                reloadInMemoryCallback: data => {
+                    if (this.data && this.overridePackageJsonManager) {
+                        this.data.packageJsonOverride = data;
+                        this.saveToDisk();
+                    }
+                },
+            });
+            if (reloading) {
+                Helpers.log(`Reloading taon.jsonc done in ${pathToTaonJson}`);
+            }
+            else {
+                Helpers.log(`Reading taon.jsonc done in ${pathToTaonJson}`);
+            }
+        }
+        catch (error) {
+            Helpers.error(`Not able to update taon.json from disk
+
+        ${pathToTaonJson}
+
+        `, false, true);
+        }
+        //#endregion
+    }
+    //#endregion
+    //#region reload from disk
+    /**
+     * Reload taon json from disk
+     * @deprecated
+     */
+    reloadFromDisk() {
+        //#region @backendFunc
+        this.readFromdisk(this.path, true);
+        //#endregion
+    }
+    //#endregion
+    //#region exists
+    get exists() {
+        return Helpers.exists(this.project.pathFor(taonJsonMainProject));
+    }
+    //#endregion
+    //#region save
+    preserveOldTaonProps() {
+        if (this.project.framework.isContainer &&
+            this.project.framework.isCoreProject) {
+            return;
+        }
+        const data = this.data;
+        if (data.overrided?.includeOnly && !data.dependenciesNamesForNpmLib) {
+            data.dependenciesNamesForNpmLib = _.cloneDeep(data.overrided.includeOnly);
+            delete data.overrided.includeOnly;
+        }
+        if (this.project.framework.isStandaloneProject) {
+            const dataToClean = this.data;
+            delete dataToClean.monorepo;
+            delete dataToClean['smart'];
+            delete dataToClean['smartContainerBuildTarget'];
+        }
+        for (const prop of [
+            ...OVERRIDE_FROM_TNP,
+            'overrided',
+            'required',
+            'requiredServers',
+            'main',
+            'useFramework',
+            'isGenerated',
+            'workerPlugins',
+            'smartContainerTarget',
+            'libReleaseOptions',
+            'linkedRepos',
+        ]) {
+            delete data[prop];
+        }
+        if (!this.appId) {
+            const mainConfig = EnvOptions.from(this.project.environmentConfig.getEnvMain());
+            this.appId = Utils.uniqArray((`${mainConfig.website.domain
+                .replace(this.project.nameForNpmPackage, '')
+                .replace(this.project.name, '')
+                .split('.')
+                .reverse()
+                .join('.')}` +
+                `.${this.project.nameForNpmPackage
+                    .replace(/\@/g, '')
+                    .replace(/\//g, '.')}`).split('.')).join('.');
+        }
+        this.saveToDisk('preserve old taon props');
+    }
+    preservePropsFromPackageJson() {
+        if (this.project.framework.isContainer &&
+            this.project.framework.isCoreProject) {
+            return;
+        }
+        const exitedPackageJson = this.project.packageJson.getAllData() || {};
+        const packageJsonOverrideData = this.overridePackageJsonManager.getAllData() || {};
+        const lastBuildTagHash = this.overridePackageJsonManager.getBuildHash();
+        for (const prop of OVERRIDE_FROM_TNP) {
+            if (_.isUndefined(packageJsonOverrideData[prop]) &&
+                !_.isUndefined(exitedPackageJson[prop])) {
+                packageJsonOverrideData[prop] = exitedPackageJson[prop];
+            }
+        }
+        this.overridePackageJsonManager.setAllData({
+            ...packageJsonOverrideData,
+            lastBuildTagHash,
+        });
+    }
+    saveToDisk(purpose) {
+        //#region @backend
+        Helpers.log(`Saving taon.jsonc ${purpose ? `(${purpose})` : ''}`);
+        if (this.isCoreProject && this.project.framework.isContainer) {
+            this.project.writeJsonC(taonJsonMainProject, this.data);
+        }
+        else {
+            const sorted = Utils.sortKeys(_.cloneDeep(this.data));
+            const packageJsonOverride = sorted.packageJsonOverride || {};
+            if (!packageJsonOverride.author) {
+                packageJsonOverride.author = _.startCase(os.userInfo().username);
+            }
+            if (!packageJsonOverride.description) {
+                packageJsonOverride.description = `Description for ${this.project.name}. Hello world!`;
+            }
+            delete sorted.packageJsonOverride;
+            const showFirst = ['type', 'version', 'dependenciesNamesForNpmLib'];
+            for (const key of showFirst) {
+                delete sorted[key];
+            }
+            const destinationObject = {
+                ...showFirst.reduce((acc, key) => {
+                    acc[key] = this.data[key];
+                    return acc;
+                }, {}),
+                ...sorted,
+                packageJsonOverride,
+            };
+            scriptsCommands.forEach(command => {
+                delete ((destinationObject.packageJsonOverride || {}).scripts || {})[command];
+            });
+            this.project.writeJsonC(taonJsonMainProject, destinationObject);
+        }
+        this.project.packageJson.saveToDisk();
+        //#endregion
+    }
+    //#endregion
+    //#region type
+    get type() {
+        const res = this.data?.type;
+        if (_.isString(res)) {
+            return res;
+        }
+        if (this.project.hasFile(packageJsonMainProject)) {
+            return LibTypeEnum.UNKNOWN_NPM_PROJECT;
+        }
+        return LibTypeEnum.UNKNOWN;
+    }
+    //#endregion
+    //#region resources
+    /**
+     * Resource to include in npm lib
+     * (relative paths to files or folders)
+     */
+    get resources() {
+        //#region @backendFunc
+        return this.data?.resources || [];
+        //#endregion
+    }
+    //#endregion
+    //#region base content url
+    /**
+     * Base url for content (docs, md files etc.)
+     * Required if README.md has relative pathes to links
+     */
+    get baseContentUrl() {
+        //#region @backendFunc
+        return this.data?.baseContentUrl;
+        //#endregion
+    }
+    //#endregion
+    //#region base images url
+    /**
+     * Base url for content (docs, md files etc.)
+     * Required if README.md has relative pathes to images
+     */
+    get baseImagesUrl() {
+        //#region @backendFunc
+        return this.data?.baseImagesUrl;
+        //#endregion
+    }
+    //#endregion
+    //#region store generated assets in repo
+    get storeGeneratedAssetsInRepository() {
+        //#region @backendFunc
+        return !!this.data
+            ?.storeGeneratedAssetsInRepository;
+        //#endregion
+    }
+    //#endregion
+    //#region store local release files in repo
+    get storeLocalReleaseFilesInRepository() {
+        //#region @backendFunc
+        return !!this.data
+            ?.storeLocalReleaseFilesInRepository;
+        //#endregion
+    }
+    //#endregion
+    //#region dependencies names for npm lib
+    /**
+     * Dependencies for npm lib (non isomorphic)
+     */
+    get dependenciesNamesForNpmLib() {
+        //#region @backendFunc
+        let res = this.data
+            ?.dependenciesNamesForNpmLib;
+        if (!_.isArray(res)) {
+            return this.data.overrided?.includeOnly || [];
+        }
+        return res || [];
+        //#endregion
+    }
+    //#endregion
+    //#region override packages order
+    get overridePackagesOrder() {
+        //#region @backendFunc
+        let res = this.data?.overridePackagesOrder;
+        return res || [];
+        //#endregion
+    }
+    //#endregion
+    setDependenciesNamesForNpmLib(dependencies) {
+        //#region @backendFunc
+        const data = this.data;
+        data.dependenciesNamesForNpmLib = dependencies;
+        this.saveToDisk('updating dependencies for npm lib');
+        //#endregion
+    }
+    //#region isomorphic dependencies names for npm lib
+    /**
+     * External isomorphic dependencies for npm lib
+     * (build-in/core taon isomorphic packages will not be here)
+     */
+    get isomorphicDependenciesForNpmLib() {
+        //#region @backendFunc
+        let res = this.data
+            ?.isomorphicDependenciesForNpmLib;
+        return res || [];
+        //#endregion
+    }
+    //#endregion
+    //#region isomorphic dependencies names for npm lib
+    /**
+     * External isomorphic dependencies for npm lib
+     * (build-in/core taon isomorphic packages will not be here)
+     */
+    get devModeDependenciesForNpmLib() {
+        //#region @backendFunc
+        let res = this.data
+            ?.devModeDependenciesForNpmLib;
+        return res || this.isomorphicDependenciesForNpmLib;
+        //#endregion
+    }
+    //#endregion
+    //#region set isomorphic dependencies for npm lib
+    setIsomorphicDependenciesForNpmLib(dependencies) {
+        //#region @backendFunc
+        const data = this.data;
+        data.isomorphicDependenciesForNpmLib = dependencies;
+        this.saveToDisk('updating isomorphic dependencies for npm lib');
+        //#endregion
+    }
+    //#endregion
+    //#region additional externals for
+    additionalExternalsFor(artifactName) {
+        //#region @backendFunc
+        let res = this.data?.singleFileBundlingPackages
+            ?.filter(c => {
+            return (c.isExternalFor === '*' || c.isExternalFor.includes(artifactName));
+        })
+            .map(c => c.packageName);
+        return res || [];
+        //#endregion
+    }
+    //#endregion
+    //#region additional replace with nothing for
+    additionalReplaceWithNothingFor(artifactName) {
+        //#region @backendFunc
+        let res = this.data?.singleFileBundlingPackages
+            ?.filter(c => {
+            return (c.replaceWithNothing === '*' ||
+                (Array.isArray(c.replaceWithNothing) &&
+                    c.replaceWithNothing.includes(artifactName)));
+        })
+            .map(c => c.packageName);
+        return res || [];
+        //#endregion
+    }
+    //#endregion
+    //#region native deps for
+    getNativeDepsFor(artifactName) {
+        //#region @backendFunc
+        let res = this.data?.singleFileBundlingPackages
+            ?.filter(c => {
+            return (c.includeInBundleNodeModules === '*' ||
+                (Array.isArray(c.includeInBundleNodeModules) &&
+                    c.includeInBundleNodeModules.includes(artifactName)));
+        })
+            .map(c => c.packageName);
+        return res || [];
+        //#endregion
+    }
+    //#endregion
+    //#region peerDependencies names for npm lib
+    /**
+     * Peer deps to inlculde in npm lib
+     * (relative paths to files or folders)
+     */
+    get peerDependenciesNamesForNpmLib() {
+        //#region @backendFunc
+        let res = this.data
+            ?.peerDependenciesNamesForNpmLib;
+        return res || [];
+        //#endregion
+    }
+    //#endregion
+    get numOfAdditionalEntrypointsForAppTs() {
+        //#region @backendFunc
+        let res = this.data
+            ?.numOfAdditionalEntrypoints;
+        if (res && res['app.ts']) {
+            return Number(res['app.ts']) || 0;
+        }
+        return 0;
+        //#endregion
+    }
+    /**
+     * Peer deps to inlculde in npm lib
+     * (relative paths to files or folders)
+     */
+    get devDependenciesNamesForNpmLib() {
+        //#region @backendFunc
+        let res = this.data
+            ?.devDependenciesNamesForNpmLib;
+        return res || [];
+        //#endregion
+    }
+    //#endregion
+    setPeerDependenciesNamesForNpmLib(dependencies) {
+        //#region @backendFunc
+        const data = this.data;
+        data.peerDependenciesNamesForNpmLib = dependencies;
+        this.saveToDisk('updating peer dependencies for npm lib');
+        //#endregion
+    }
+    //#region peerDependencies names for npm lib
+    /**
+     * Peer deps to inlculde in npm lib
+     * (relative paths to files or folders)
+     */
+    get optionalDependenciesNamesForNpmLib() {
+        //#region @backendFunc
+        let res = this.data
+            ?.optionalDependenciesNamesForNpmLib;
+        return res || [];
+        //#endregion
+    }
+    //#endregion
+    //#region set new version
+    setType(type) {
+        //#region @backendFunc
+        const data = this.data;
+        Helpers.info(`Setting type to project  ${this.project.genericName}: ${type}`);
+        data.type = type;
+        this.saveToDisk(`setting new type "${type}"`);
+        //#endregion
+    }
+    //#endregion
+    //#region set framework version
+    async setFrameworkVersion(frameworkVersionArg) {
+        //#region @backendFunc
+        this.data.version = frameworkVersionArg;
+        this.saveToDisk('updating framework version');
+        //#endregion
+    }
+    //#endregion
+    //#region uses its own node_modules
+    get isUsingOwnNodeModulesInsteadCoreContainer() {
+        const data = this.data;
+        //#region @backendFunc
+        let res = data?.isUsingOwnNodeModulesInsteadCoreContainer;
+        return !!res;
+        //#endregion
+    }
+    //#endregion
+    //#region uses its own node_modules
+    get linkNodeModulesFromCoreContainer() {
+        const data = this.data;
+        //#region @backendFunc
+        let res = data?.linkNodeModulesFromCoreContainer;
+        return !!res;
+        //#endregion
+    }
+    //#endregion
+    //#region should generate src/lib/index file
+    get shouldGenerateAutogenIndexFile() {
+        const data = this.data;
+        //#region @backendFunc
+        return !!data?.shouldGenerateAutogenIndexFile;
+        //#endregion
+    }
+    //#endregion
+    setShouldGenerateAutogenIndexFile(value) {
+        const data = this.data;
+        data.shouldGenerateAutogenIndexFile = value;
+        this.saveToDisk('updating shouldGenerateAutogenIndexFile');
+    }
+    setShouldGenerateAutogenAppRoutes(value) {
+        const data = this.data;
+        data.shouldGenerateAutogenAppRoutesFile = value;
+        this.saveToDisk('updating shouldGenerateAutogenAppRoutesFile');
+    }
+    setCloudFlareAccountSubdomain(value) {
+        const data = this.data;
+        data.cloudFlareAccountSubdomain = value;
+        this.saveToDisk('updating cloudFlareAccountSubdomain');
+    }
+    get cloudFlareAccountSubdomain() {
+        //#region @backendFunc
+        const data = this.data;
+        return data?.cloudFlareAccountSubdomain;
+        //#endregion
+    }
+    //#region should generate app.ts routes,imports and context initializations file
+    get shouldGenerateAutogenAppRoutesFile() {
+        const data = this.data;
+        //#region @backendFunc
+        return !!data?.shouldGenerateAutogenAppRoutesFile;
+        //#endregion
+    }
+    //#endregion
+    //#region is monorepo
+    get isMonorepo() {
+        //#region @backendFunc
+        const data = this.data;
+        return !!data?.monorepo;
+        //#endregion
+    }
+    //#endregion
+    //#region is organization
+    get isOrganization() {
+        //#region @backendFunc
+        const data = this.data;
+        return !!data?.organization;
+        //#endregion
+    }
+    //#endregion
+    //#region name when inside organization
+    get nameWhenInsideOrganiation() {
+        //#region @backendFunc
+        const data = this.data;
+        return data?.overrideNameWhenInsideOrganization;
+        //#endregion
+    }
+    //#endregion
+    //#region override name for cli
+    get overrideNameForCli() {
+        //#region @backendFunc
+        const data = this.data;
+        return data?.overrideNameForCli;
+        //#endregion
+    }
+    //#endregion
+    //#region name when inside organization
+    get overrideNpmName() {
+        //#region @backendFunc
+        const data = this.data;
+        return data?.overrideNpmName;
+        //#endregion
+    }
+    //#endregion
+    //#region is core project
+    get isCoreProject() {
+        //#region @backendFunc
+        return !!this.data?.isCoreProject;
+        //#endregion
+    }
+    //#endregion
+    //#region framework version
+    get frameworkVersion() {
+        //#region @backendFunc
+        return this.data?.version;
+        //#endregion
+    }
+    //#endregion
+    //#region app id
+    get appId() {
+        //#region @backendFunc
+        return this.data?.appId;
+        //#endregion
+    }
+    set appId(value) {
+        //#region @backend
+        const data = this.data;
+        data.appId = value;
+        this.saveToDisk('updating appId');
+        //#endregion
+    }
+    //#endregion
+    //#region folders to remove after pulling from git
+    get removeAfterPullingFromGit() {
+        //#region @backendFunc
+        const data = this.data;
+        return Array.isArray(data?.removeAfterPullingFromGit)
+            ? data?.removeAfterPullingFromGit
+            : [];
+        //#endregion
+    }
+    //#endregion
+    //#region link to
+    linkTo(destination) {
+        //#region @backendFunc
+        const source = this.project.pathFor(taonJsonMainProject);
+        const dest = crossPlatformPath([destination, taonJsonMainProject]);
+        Helpers.removeFileIfExists(dest);
+        Helpers.createSymLink(source, dest);
+        //#endregion
+    }
+    //#endregion
+    //#region auto release config allowed items
+    get autoReleaseConfigAllowedItems() {
+        const data = this.data;
+        return data?.autoReleaseConfigAllowedItems || [];
+    }
+    get createOnlyTagWhenRelease() {
+        const data = this.data;
+        return !!data?.createOnlyTagWhenRelease;
+    }
+    set autoReleaseConfigAllowedItems(items) {
+        const data = this.data;
+        data.autoReleaseConfigAllowedItems = items;
+        this.saveToDisk('updating auto release config allowed items');
+    }
+    //#endregion
+    //#region update isomorphic external depenencies
+    detectAndUpdateNpmExternalDependencies() {
+        //#region @backendFunc
+        Helpers.taskStarted(`Updating isomorphic external dependencies`);
+        let allDetectedNpmDeps = this.project.framework.allDetectedExternalNPmDependenciesForNpmLibCode;
+        this.setDependenciesNamesForNpmLib(allDetectedNpmDeps);
+        Helpers.taskDone(`Done updating npm external dependencies`);
+        //#endregion
+    }
+    detectAndUpdateIsomorphicExternalDependencies() {
+        //#region @backendFunc
+        Helpers.taskStarted(`Updating isomorphic external dependencies`);
+        let allDetectedIsomorphicDeps = this.project.framework
+            .allDetectedExternalIsomorphicDependenciesForNpmLibCode;
+        allDetectedIsomorphicDeps = allDetectedIsomorphicDeps.filter(f => ![this.project.name, this.project.nameForNpmPackage].includes(f));
+        this.setIsomorphicDependenciesForNpmLib(allDetectedIsomorphicDeps);
+        let isomorphicDependenciesForNpmLib = this.dependenciesNamesForNpmLib.filter(d => !allDetectedIsomorphicDeps.includes(d));
+        isomorphicDependenciesForNpmLib = isomorphicDependenciesForNpmLib.filter(f => ![this.project.name, this.project.nameForNpmPackage].includes(f));
+        this.setDependenciesNamesForNpmLib(isomorphicDependenciesForNpmLib);
+        let peerDependenciesNamesForNpmLib = this.peerDependenciesNamesForNpmLib.filter(d => !allDetectedIsomorphicDeps.includes(d));
+        peerDependenciesNamesForNpmLib = peerDependenciesNamesForNpmLib.filter(f => ![this.project.name, this.project.nameForNpmPackage].includes(f));
+        this.setPeerDependenciesNamesForNpmLib(peerDependenciesNamesForNpmLib);
+        Helpers.taskDone(`Done updating isomorphic external dependencies`);
+        //#endregion
+    }
+    //#endregion
+    async updateDependenciesFromNpm(options) {
+        //#region @backendFunc
+        options = options || {};
+        options.onlyPackageNames = options.onlyPackageNames || [];
+        const allDeps = this.project.packageJson.allDependencies;
+        // const overrideAndUpdateAllToLatest = false;
+        // await Helpers.questionYesNo(
+        //   'update all to latest ?',
+        // );
+        const allDepsKeys = Object.keys(allDeps);
+        for (let index = 0; index < allDepsKeys.length; index++) {
+            Helpers.clearConsole();
+            const packageName = allDepsKeys[index];
+            if (options.onlyPackageNames.length > 0 &&
+                !options.onlyPackageNames.includes(packageName)) {
+                continue;
+            }
+            const currentPackageVersion = allDeps[packageName];
+            // const currentVerObj = UtilsNpm.getVerObj(currentPackageVersion);
+            const taonJsonContent = this.project.readFile(taonJsonMainProject);
+            const tags = UtilsJson.getAtrributiesFromJsonWithComments(packageName, taonJsonContent);
+            Helpers.info(`(${index + 1} / ${allDepsKeys.length}) ` +
+                `Downloading info about "${packageName}" (current ver: ${currentPackageVersion})`);
+            if (currentPackageVersion === 'latest') {
+                console.log(`Package "${packageName}" is set to latest. Skipping.`);
+                continue;
+            }
+            //#region resolve tags
+            const updateToContainerMajor = tags.find(c => c.name === '@updateToContainerMajor');
+            const trustedMajor = !!tags.find(c => c.name === '@trusted' && c.value === 'major');
+            const trustedMinor = !!tags.find(c => c.name === '@trusted' && c.value === 'minor');
+            const trustedPath = !!tags.find(c => c.name === '@trusted' && c.value === 'patch');
+            //#endregion
+            //#region check for @updateToContainerMajor
+            if (updateToContainerMajor) {
+                const containerMajorVersion = `~${this.project.taonJson.frameworkVersion.replace('v', '')}.0.0`;
+                this.project.packageJson.updateDependency({
+                    packageName,
+                    version: containerMajorVersion,
+                });
+                this.project.taonJson.overridePackageJsonManager.updateDependency({
+                    packageName,
+                    version: containerMajorVersion,
+                });
+                continue;
+            }
+            //#endregion
+            if (!trustedMajor && !trustedMinor && !trustedPath) {
+                console.log(`Package "${packageName}" is not trusted for any updates. Skipping.`);
+                continue;
+            }
+            const latestType = trustedMajor
+                ? 'major'
+                : trustedMinor
+                    ? 'minor'
+                    : 'patch';
+            let latestToUpdate = await UtilsNpm.getLatestVersionFromNpm(packageName, {
+                currentPackageVersion,
+                latestType,
+                skipAlphaBetaNext: true,
+            });
+            const prefix = currentPackageVersion.startsWith('^')
+                ? '^'
+                : currentPackageVersion.startsWith('~')
+                    ? '~'
+                    : '';
+            this.project.packageJson.updateDependency({
+                packageName,
+                version: `${prefix}${latestToUpdate}`,
+            });
+            this.project.taonJson.overridePackageJsonManager.updateDependency({
+                packageName,
+                version: `${prefix}${latestToUpdate}`,
+            });
+        }
+        //#endregion
+    }
+}
+//# sourceMappingURL=taonJson.js.map