@contrail/cli 3.4.2 → 3.4.4-alpha.1

package/dist/commands/types/uploadTypes.js

@@ -1,36 +1,36 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadTypes = void 0;
-const type_uploader_1 = require("../../helpers/types/type-uploader");
-const core_1 = require("@oclif/core");
-const basecommand_1 = require("../../basecommand");
-class UploadTypes extends basecommand_1.BaseCommand {
-    static description = 'Upload Types Org. OptionSets are loaded from .yml files in the types directory.';
-    static examples = [
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadTypes = void 0;
+const type_uploader_1 = require("../../helpers/types/type-uploader");
+const core_1 = require("@oclif/core");
+const basecommand_1 = require("../../basecommand");
+class UploadTypes extends basecommand_1.BaseCommand {
+    static description = 'Upload Types Org. OptionSets are loaded from .yml files in the types directory.';
+    static examples = [
         `$ contrail types uploadTypes
-`,
-    ];
-    static flags = {
-        ...basecommand_1.BaseCommand.baseFlags,
-        dir: core_1.Flags.string({
-            char: 'd',
-            description: 'The directory from which to export the option set data. Defaults to the current directory. The option set data will be loaded from $dir/types',
-            required: false,
-            default: '.',
-        }),
-        merge: core_1.Flags.boolean({
-            char: 'm',
-            description: 'Merge types and type properties without deleting missing ones. Only adds/updates those present in the source files.',
-            required: false,
-            default: false,
-        }),
-    };
-    async run() {
-        return await uploadTypes(this.flags.dir, this.flags.merge);
-    }
-}
-exports.default = UploadTypes;
-async function uploadTypes(dir, isMerge) {
-    await (0, type_uploader_1.uploadTypes)(dir, { isMerge });
-}
-exports.uploadTypes = uploadTypes;
+`,
+    ];
+    static flags = {
+        ...basecommand_1.BaseCommand.baseFlags,
+        dir: core_1.Flags.string({
+            char: 'd',
+            description: 'The directory from which to export the option set data. Defaults to the current directory. The option set data will be loaded from $dir/types',
+            required: false,
+            default: '.',
+        }),
+        merge: core_1.Flags.boolean({
+            char: 'm',
+            description: 'Merge types and type properties without deleting missing ones. Only adds/updates those present in the source files.',
+            required: false,
+            default: false,
+        }),
+    };
+    async run() {
+        return await uploadTypes(this.flags.dir, this.flags.merge);
+    }
+}
+exports.default = UploadTypes;
+async function uploadTypes(dir, isMerge) {
+    await (0, type_uploader_1.uploadTypes)(dir, { isMerge });
+}
+exports.uploadTypes = uploadTypes;

package/dist/commands/types/uploadUsageInfo.d.ts

@@ -1,12 +1,15 @@
-import { BaseCommand } from '../../basecommand';
-export default class UploadUsageInfo extends BaseCommand {
-    static description: string;
-    static examples: string[];
-    static flags: {
-        dir: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        alwaysConfirmEnv: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        logLevel: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-    };
-    run(): Promise<void>;
-}
-export declare function uploadUsageInfo(dir: string): Promise<void>;
+import { BaseCommand } from '../../basecommand';
+import { PersistReducedUsageInfo } from '../../interfaces';
+export default class UploadUsageInfo extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        dir: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        alwaysConfirmEnv: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        logLevel: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<void>;
+}
+export declare function uploadUsageInfo(dir: string): Promise<void>;
+export declare const persistReducedUsageInfoFields: readonly ["typeId", "typePropertyId", "editable", "used", "formulaFunction", "validationFunction", "numberFormat", "defaultValue", "label", "required", "searchable", "isUniqueProperty", "isUniquePropertyInFamily", "copyBehavior", "copyDefault", "propertyLevel", "isArchived", "isFederationProperty", "carryOverBehavior", "carryOverDefault"];
+export declare function transformReducedUsageInfoToTypeIdsFromPath(reducedUsageInfo: any, types: any): PersistReducedUsageInfo | undefined;

package/dist/commands/types/uploadUsageInfo.js

@@ -1,173 +1,180 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadUsageInfo = void 0;
-const tslib_1 = require("tslib");
-const sdk_1 = require("@contrail/sdk");
-const fs_1 = tslib_1.__importDefault(require("fs"));
-const login_1 = require("../../auth/login");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const path = tslib_1.__importStar(require("path"));
-const core_1 = require("@oclif/core");
-const type_extractor_1 = require("../../helpers/types/type-extractor");
-const basecommand_1 = require("../../basecommand");
-const logger_1 = tslib_1.__importDefault(require("../../logger"));
-const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
-class UploadUsageInfo extends basecommand_1.BaseCommand {
-    static description = 'Upload extracted usage info';
-    static examples = [
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformReducedUsageInfoToTypeIdsFromPath = exports.persistReducedUsageInfoFields = exports.uploadUsageInfo = void 0;
+const tslib_1 = require("tslib");
+const sdk_1 = require("@contrail/sdk");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const login_1 = require("../../auth/login");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const path = tslib_1.__importStar(require("path"));
+const core_1 = require("@oclif/core");
+const type_extractor_1 = require("../../helpers/types/type-extractor");
+const basecommand_1 = require("../../basecommand");
+const logger_1 = tslib_1.__importDefault(require("../../logger"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+class UploadUsageInfo extends basecommand_1.BaseCommand {
+    static description = 'Upload extracted usage info';
+    static examples = [
         `$ contrail types uploadUsageInfo
-`,
-    ];
-    static flags = {
-        ...basecommand_1.BaseCommand.baseFlags,
-        dir: core_1.Flags.string({
-            char: 'd',
-            description: 'The directory from which to export the usage info data. Defaults to the current directory. The usage info data will be loaded from $dir/usage-info.yml',
-            required: false,
-            default: '.',
-        }),
-    };
-    async run() {
-        await uploadUsageInfo(this.flags.dir);
-    }
-}
-exports.default = UploadUsageInfo;
-async function uploadUsageInfo(dir) {
-    try {
-        await (0, login_1.authUser)();
-        logger_1.default.info(`${chalk_1.default.yellow.bold('USAGE INFO')} Uploading`);
-        const reducedUsageInfo = await loadUsageInfo(dir);
-        await uploadUsageInfoObjects(reducedUsageInfo);
-        logger_1.default.info(`${chalk_1.default.yellow.bold('USAGE INFO')} Uploaded`);
-    }
-    catch (e) {
-        logger_1.default.info(`${chalk_1.default.red.bold('FAIL')} Usage Info Upload Failed . ${e}`);
-        return;
-    }
-    logger_1.default.info(`${chalk_1.default.green.bold('COMPLETE')} Usage Info Upload Complete.`);
-}
-exports.uploadUsageInfo = uploadUsageInfo;
-function loadUsageInfo(dir) {
-    try {
-        const doc = js_yaml_1.default.load(fs_1.default.readFileSync(path.join(dir, 'usage-info.yml'), 'utf8'));
-        return doc;
-    }
-    catch (e) {
-        throw new Error(`ERROR PARSING YAML: ${e}`);
-    }
-}
-async function uploadUsageInfoObjects(loadedUsageInfo) {
-    const typesWithProperties = await (0, type_extractor_1.getTypes)();
-    const typeProperties = typesWithProperties
-        .filter((t) => !!t.typeProperties)
-        .map((t) => t.typeProperties)
-        .reduce((a, b) => a.concat(b));
-    const currentUsageInfo = await new sdk_1.Entities().get({
-        entityName: 'type-property-usage-info',
-    });
-    const currentUsageInfosHashes = {};
-    for (const currentUI of currentUsageInfo) {
-        const foundType = typesWithProperties.find((t) => t.id === currentUI.typeId);
-        const foundTypeProperty = typeProperties.find((tp) => tp.id === currentUI.typePropertyId);
-        if (!foundType || !foundTypeProperty) {
-            logger_1.default.info(`skipping unhashable, invalid usage info: ${JSON.stringify(currentUI, null, 2)}`);
-            continue;
-        }
-        const hash = `${foundType.slug}|${foundTypeProperty.slug}`;
-        currentUsageInfosHashes[hash] = currentUI;
-    }
-    const reducedUsageInfoHashes = {};
-    for (const loadedUI of loadedUsageInfo) {
-        const hash = `${loadedUI.typeSlug}|${loadedUI.typePropertySlug}`;
-        reducedUsageInfoHashes[hash] = loadedUI;
-    }
-    logger_1.default.debug(`current usage info: ${currentUsageInfo}`);
-    logger_1.default.debug('loaded usage info:', loadedUsageInfo);
-    for (const loadedUI of loadedUsageInfo) {
-        try {
-            const found = currentUsageInfosHashes[`${loadedUI.typeSlug}|${loadedUI.typePropertySlug}`];
-            if (!found) {
-                if (!transformReducedUI(loadedUI, typesWithProperties, typeProperties)) {
-                    continue;
-                }
-                logger_1.default.debug(`Creating:  ${loadedUI}`);
-                await new sdk_1.Entities().create({
-                    entityName: 'type-property-usage-info',
-                    object: {
-                        typePropertyId: loadedUI.typePropertyId,
-                        typeId: loadedUI.typeId,
-                        editable: loadedUI.editable,
-                        used: loadedUI.used,
-                        formulaFunction: loadedUI.formulaFunction,
-                        validationFunction: loadedUI.validationFunction,
-                        numberFormat: loadedUI.numberFormat,
-                        defaultValue: loadedUI.defaultValue,
-                        label: loadedUI.label,
-                        isArchived: loadedUI.isArchived,
-                    },
-                });
-            }
-            else {
-                if (!transformReducedUI(loadedUI, typesWithProperties, typeProperties)) {
-                    continue;
-                }
-                logger_1.default.info(`Updating:  ${loadedUI}`);
-                await new sdk_1.Entities().update({
-                    entityName: 'type-property-usage-info',
-                    id: found.id,
-                    object: {
-                        editable: loadedUI?.editable,
-                        used: loadedUI?.used,
-                        formulaFunction: loadedUI?.formulaFunction,
-                        validationFunction: loadedUI?.validationFunction,
-                        numberFormat: loadedUI?.numberFormat,
-                        defaultValue: loadedUI?.defaultValue,
-                        label: loadedUI?.label,
-                        required: loadedUI?.required,
-                        searchable: loadedUI?.searchable,
-                        isUniqueProperty: loadedUI?.isUniqueProperty,
-                        isUniquePropertyInFamily: loadedUI?.isUniquePropertyInFamily,
-                        copyBehavior: loadedUI?.copyBehavior,
-                        copyDefault: loadedUI?.copyDefault,
-                        propertyLevel: loadedUI?.propertyLevel,
-                        isArchived: loadedUI?.isArchived,
-                    },
-                });
-            }
-        }
-        catch (err) {
-            logger_1.default.error(`Error Uploading usage info: ${err}`);
-        }
-    }
-    for (const [hash, currentUI] of Object.entries(currentUsageInfosHashes)) {
-        try {
-            const found = reducedUsageInfoHashes[hash];
-            if (!found) {
-                logger_1.default.debug(`Creating:  ${hash}`);
-                await new sdk_1.Entities().delete({
-                    entityName: 'type-property-usage-info',
-                    id: currentUI['id'],
-                });
-            }
-        }
-        catch (err) {
-            logger_1.default.error(`Error Deleting usage info: ${err}`);
-        }
-    }
-}
-// transforms the reduced Usage Info from name slugs to ids
-function transformReducedUI(reducedUsageInfo, types, typeProperties) {
-    const foundType = types.find((t) => t.slug === reducedUsageInfo.typeSlug);
-    if (!foundType) {
-        logger_1.default.error(`Could not find type with slug ${reducedUsageInfo.typeSlug} while transforming ${reducedUsageInfo}`);
-        return false;
-    }
-    reducedUsageInfo.typeId = foundType.id;
-    const foundTypeProperty = typeProperties.find((tp) => tp.slug === reducedUsageInfo.typePropertySlug);
-    if (!foundTypeProperty) {
-        logger_1.default.error(`Could not find type property with slug ${reducedUsageInfo.typePropertySlug} while transforming ${reducedUsageInfo}`);
-        return false;
-    }
-    reducedUsageInfo.typePropertyId = foundTypeProperty.id;
-    return true;
-}
+`,
+    ];
+    static flags = {
+        ...basecommand_1.BaseCommand.baseFlags,
+        dir: core_1.Flags.string({
+            char: 'd',
+            description: 'The directory from which to export the usage info data. Defaults to the current directory. The usage info data will be loaded from $dir/usage-info.yml',
+            required: false,
+            default: '.',
+        }),
+    };
+    async run() {
+        await uploadUsageInfo(this.flags.dir);
+    }
+}
+exports.default = UploadUsageInfo;
+async function uploadUsageInfo(dir) {
+    try {
+        await (0, login_1.authUser)();
+        logger_1.default.info(`${chalk_1.default.yellow.bold('USAGE INFO')} Uploading`);
+        const reducedUsageInfo = await loadUsageInfo(dir);
+        await uploadUsageInfoObjects(reducedUsageInfo);
+        logger_1.default.info(`${chalk_1.default.yellow.bold('USAGE INFO')} Uploaded`);
+    }
+    catch (e) {
+        logger_1.default.info(`${chalk_1.default.red.bold('FAIL')} Usage Info Upload Failed . ${e}`);
+        return;
+    }
+    logger_1.default.info(`${chalk_1.default.green.bold('COMPLETE')} Usage Info Upload Complete.`);
+}
+exports.uploadUsageInfo = uploadUsageInfo;
+function loadUsageInfo(dir) {
+    try {
+        const doc = js_yaml_1.default.load(fs_1.default.readFileSync(path.join(dir, 'usage-info.yml'), 'utf8'));
+        return doc;
+    }
+    catch (e) {
+        throw new Error(`ERROR PARSING YAML: ${e}`);
+    }
+}
+async function uploadUsageInfoObjects(loadedUsageInfo) {
+    const typesWithProperties = await (0, type_extractor_1.getTypes)();
+    const currentUsageInfo = await new sdk_1.Entities().get({
+        entityName: 'type-property-usage-info',
+    });
+    const currentUsageInfosHashes = {};
+    for (const currentUI of currentUsageInfo) {
+        const foundType = typesWithProperties.find((t) => t.id === currentUI.typeId);
+        const typeProperties = foundType?.typeProperties || [];
+        const foundTypeProperty = typeProperties.find((tp) => tp.id === currentUI.typePropertyId);
+        if (!foundType || !foundTypeProperty) {
+            logger_1.default.info(`skipping unhashable, invalid usage info: ${JSON.stringify(currentUI, null, 2)}`);
+            continue;
+        }
+        const hash = `${foundType.typePath}|${foundTypeProperty.slug}`;
+        currentUsageInfosHashes[hash] = currentUI;
+    }
+    const reducedUsageInfoHashes = {};
+    for (const loadedUI of loadedUsageInfo) {
+        const hash = `${loadedUI.typePath}|${loadedUI.typePropertySlug}`;
+        reducedUsageInfoHashes[hash] = loadedUI;
+    }
+    logger_1.default.debug(`current usage info: ${JSON.stringify(currentUsageInfo)}`);
+    logger_1.default.debug(`loaded usage info: ${JSON.stringify(loadedUsageInfo)}`);
+    for (const loadedUI of loadedUsageInfo) {
+        try {
+            const found = currentUsageInfosHashes[`${loadedUI.typePath}|${loadedUI.typePropertySlug}`];
+            const transformedUI = transformReducedUsageInfoToTypeIdsFromPath(loadedUI, typesWithProperties);
+            if (!transformedUI) {
+                continue;
+            }
+            if (!found) {
+                logger_1.default.debug(`Creating:  ${JSON.stringify(transformedUI)}`);
+                await new sdk_1.Entities().create({
+                    entityName: 'type-property-usage-info',
+                    object: transformedUI,
+                });
+            }
+            else {
+                logger_1.default.info(`Updating:  ${JSON.stringify(transformedUI)}`);
+                await new sdk_1.Entities().update({
+                    entityName: 'type-property-usage-info',
+                    id: found.id,
+                    object: transformedUI,
+                });
+            }
+        }
+        catch (err) {
+            logger_1.default.error(`Error Uploading usage info: ${err}`);
+        }
+    }
+    for (const [hash, currentUI] of Object.entries(currentUsageInfosHashes)) {
+        try {
+            const found = reducedUsageInfoHashes[hash];
+            if (!found) {
+                logger_1.default.debug(`Creating:  ${hash}`);
+                await new sdk_1.Entities().delete({
+                    entityName: 'type-property-usage-info',
+                    id: currentUI['id'],
+                });
+            }
+        }
+        catch (err) {
+            logger_1.default.error(`Error Deleting usage info: ${err}`);
+        }
+    }
+}
+//This should contain the property keys in PersistReducedUsageInfo in interfaces.ts
+//except for typePath and typePropertySlug which are used for transformation but not persisted to the database.
+// If you add a new property to PersistReducedUsageInfo, you need to add it to this array to be persisted to the database.
+exports.persistReducedUsageInfoFields = [
+    // 'typePath',
+    // 'typePropertySlug',
+    'typeId',
+    'typePropertyId',
+    'editable',
+    'used',
+    'formulaFunction',
+    'validationFunction',
+    'numberFormat',
+    'defaultValue',
+    'label',
+    'required',
+    'searchable',
+    'isUniqueProperty',
+    'isUniquePropertyInFamily',
+    'copyBehavior',
+    'copyDefault',
+    'propertyLevel',
+    'isArchived',
+    'isFederationProperty',
+    'carryOverBehavior',
+    'carryOverDefault',
+];
+// transforms the reduced Usage Info from name slugs to ids
+function transformReducedUsageInfoToTypeIdsFromPath(reducedUsageInfo, types) {
+    const foundType = types.find((t) => t.typePath === reducedUsageInfo.typePath);
+    if (!foundType) {
+        logger_1.default.error(`Could not find type with typePath ${reducedUsageInfo.typePath} while transforming ${reducedUsageInfo.typePropertySlug}`);
+        return undefined;
+    }
+    const foundTypeProperty = foundType.typeProperties?.find((tp) => tp.slug === reducedUsageInfo.typePropertySlug);
+    if (!foundTypeProperty) {
+        logger_1.default.error(`Could not find type property with slug ${reducedUsageInfo.typePropertySlug} while transforming ${JSON.stringify(reducedUsageInfo)}`);
+        return undefined;
+    }
+    // Create a new object with only the properties that are in the persistReducedUsageInfoFields array
+    // If there is a compile error on the code below, it means you added a new property to PersistReducedUsageInfo
+    // interface in interfaces.ts but forgot to add it to the persistReducedUsageInfoFields array above,
+    // It needs to be added to be persisted to the database.
+    const persistedUsageInfo = {
+        typeId: foundType.id,
+        typePropertyId: foundTypeProperty.id,
+    };
+    for (const key of Object.keys(reducedUsageInfo)) {
+        if (exports.persistReducedUsageInfoFields.includes(key)) {
+            persistedUsageInfo[key] = reducedUsageInfo[key];
+        }
+    }
+    return persistedUsageInfo;
+}
+exports.transformReducedUsageInfoToTypeIdsFromPath = transformReducedUsageInfoToTypeIdsFromPath;

package/dist/commands/types/uploadUsageInfo.spec.d.ts

@@ -0,0 +1 @@
+export {};