@contrail/cli 3.6.0-alpha-5 → 3.6.0-alpha-7

package/README.md

@@ -17,7 +17,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/3.6.0-alpha-5 darwin-arm64 node-v22.19.0
+@contrail/cli/3.6.0-alpha-7 darwin-arm64 node-v22.19.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND
@@ -546,7 +546,7 @@ EXAMPLES
 ```
 USAGE
   $ contrail entities create PATH [-l error|warn|info|debug] [-e true|false] [-n <value>] [-d] [-i <value>] [-o
-    <value>] [-p] [-r] [-s]
+    <value>] [-g] [-r] [-s]
 
 ARGUMENTS
   PATH  Path of the entity type to create
@@ -555,15 +555,15 @@ FLAGS
   -d, --dryRun                     If true, does not create the entity but simulates the creation
   -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
                                    <options: true|false>
+  -g, --generateValues             If true, generates random values for properties that are not specified. By default,
+                                   only specified properties are used.
   -i, --inputFile=<value>          A file with a JSON array of objects where each object is one entity to create. Cannot
-                                   be used with --count. Unless --precise is specified, any missing values will be
-                                   populated with random values.
+                                   be used with --count. Unless --generate-values is specified, only the properties in
+                                   the file will be used.
   -l, --logLevel=<option>          The Log Level
                                    <options: error|warn|info|debug>
   -n, --count=<value>              Number of random entities to create
   -o, --outputFile=<value>         File to save the output (optional)
-  -p, --preciseProperties          If true, does not generate random values for properties. All values must be
-                                   specified.
   -r, --readableIds                If true, uses readable IDs for the created entities
   -s, --skipHydrateRelationships   If true, does not hydrate relationships for the created entities
 
@@ -571,23 +571,23 @@ DESCRIPTION
   (BETA) Create entities
 
 EXAMPLES
-  $ contrail entities create color -n=10 # creates 10 random colors
+  $ contrail entities create color -g -n=10 # creates 10 random colors
 
-  $ contrail entities create color # creates one item
+  $ contrail entities create color -- name="Electric Blue" green=1 red=2 blue=3 # creates one color with specified properties only
 
   $ contrail entities create custom-entities:franchise
 
   $ contrail entities create project-item -n=1 -- projectId=abc # creates 10 project items within project ABC
 
-  $ contrail entities create color -r # creates a random color with a human readable ID
+  $ contrail entities create color -g -r # creates a random color with a human readable ID
 
-  $ contrail entities create color -d # simulates the creation of a random color without actually creating it
+  $ contrail entities create color -d -- name=test # simulates the creation of a color without actually creating it
 
-  $ contrail entities create custom-entity:franchise -s # creates a random color and the response does not contain hydrating relationships
+  $ contrail entities create custom-entity:franchise -s # creates an entity and the response does not contain hydrating relationships
 
-  $ contrail entities create color -p -- name=Electric Blue green=1 red=2 blue=3 # creates a color with specified properties
+  $ contrail entities create color -g -- name=Electric Blue # creates a color with the name specified and other properties auto-generated
 
-  $ contrail entities create color -o /tmp/colors.json # creates a random color and saves the output to /tmp/colors.json
+  $ contrail entities create color -o /tmp/colors.json -- name=Blue green=1 red=2 blue=3 # creates a color and saves the output to /tmp/colors.json
 ```
 
 ## `contrail entities delete ENTITYNAME`

package/dist/commands/entities/create.d.ts

@@ -11,7 +11,7 @@ export default class CreateEntity extends BaseCommand {
         dryRun: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         inputFile: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         outputFile: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        preciseProperties: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        generateValues: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         readableIds: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         skipHydrateRelationships: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         alwaysConfirmEnv: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;

package/dist/commands/entities/create.js

@@ -18,7 +18,7 @@ const file_helpers_1 = require("../../helpers/file-helpers");
 let IS_DRY_RUN = false;
 let SHOULD_USE_READABLE_IDS = false;
 let SHOULD_SKIP_HYDRATE_RELATIONSHIPS = false;
-let SHOULD_ONLY_USE_SPECIFIED_PROPERTIES = false;
+let SHOULD_GENERATE_MISSING_VALUES = false;
 let NUM_ENTITIES_TO_CREATE = 1; // Default to creating one entity if not specified
 const getNumEntitiesToCreate = () => NUM_ENTITIES_TO_CREATE; // method to get the latest number in case this changes later
 const baseValidationMap = {
@@ -90,7 +90,8 @@ const FIND_VALID_VALUE_MAP = {
                 if (entity.itemFamilyId)
                     return; // skip if already specified
                 if (entity.roles?.includes('option')) {
-                    entity.itemFamilyId = Array.from(validValues)[Math.floor(Math.random() * validValues.size)];
+                    entity.itemFamilyId =
+                        Array.from(validValues)[Math.floor(Math.random() * validValues.size)];
                     // can reuse itemFamilyId for options
                 }
             },
@@ -145,15 +146,15 @@ const FIND_VALID_VALUE_MAP = {
 class CreateEntity extends basecommand_1.BaseCommand {
     static description = '(BETA) Create entities';
     static examples = [
-        'contrail entities create color -n=10 # creates 10 random colors',
-        'contrail entities create color # creates one item',
+        'contrail entities create color -g -n=10 # creates 10 random colors',
+        'contrail entities create color -- name="Electric Blue" green=1 red=2 blue=3 # creates one color with specified properties only',
         'contrail entities create custom-entities:franchise',
         'contrail entities create project-item -n=1 -- projectId=abc # creates 10 project items within project ABC',
-        'contrail entities create color -r # creates a random color with a human readable ID',
-        'contrail entities create color -d # simulates the creation of a random color without actually creating it',
-        'contrail entities create custom-entity:franchise -s # creates a random color and the response does not contain hydrating relationships',
-        'contrail entities create color -p -- name=Electric Blue green=1 red=2 blue=3 # creates a color with specified properties',
-        'contrail entities create color -o /tmp/colors.json # creates a random color and saves the output to /tmp/colors.json',
+        'contrail entities create color -g -r # creates a random color with a human readable ID',
+        'contrail entities create color -d -- name=test # simulates the creation of a color without actually creating it',
+        'contrail entities create custom-entity:franchise -s # creates an entity and the response does not contain hydrating relationships',
+        'contrail entities create color -g -- name=Electric Blue # creates a color with the name specified and other properties auto-generated',
+        'contrail entities create color -o /tmp/colors.json -- name=Blue green=1 red=2 blue=3 # creates a color and saves the output to /tmp/colors.json',
     ];
     static flags = {
         ...basecommand_1.BaseCommand.baseFlags,
@@ -170,7 +171,7 @@ class CreateEntity extends basecommand_1.BaseCommand {
         }),
         inputFile: core_1.Flags.string({
             char: 'i',
-            description: 'A file with a JSON array of objects where each object is one entity to create. Cannot be used with --count. Unless --precise is specified, any missing values will be populated with random values.',
+            description: 'A file with a JSON array of objects where each object is one entity to create. Cannot be used with --count. Unless --generate-values is specified, only the properties in the file will be used.',
             required: false,
             multiple: false,
         }),
@@ -180,9 +181,9 @@ class CreateEntity extends basecommand_1.BaseCommand {
             required: false,
             multiple: false,
         }),
-        preciseProperties: core_1.Flags.boolean({
-            char: 'p',
-            description: 'If true, does not generate random values for properties. All values must be specified.',
+        generateValues: core_1.Flags.boolean({
+            char: 'g',
+            description: 'If true, generates random values for properties that are not specified. By default, only specified properties are used.',
             required: false,
             default: false,
         }),
@@ -211,7 +212,7 @@ class CreateEntity extends basecommand_1.BaseCommand {
         this.log('🚨 This command is in BETA and may change or be removed at any time.');
         await (0, login_1.authUser)();
         const { flags, argv, args } = await this.parse(CreateEntity);
-        const { count, dryRun: isDryRun, inputFile: inputFilename, outputFile: outputFilename, preciseProperties: shouldOnlyUseSpecifiedProperties, readableIds: shouldUseReadableIds, skipHydrateRelationships, } = flags;
+        const { count, dryRun: isDryRun, inputFile: inputFilename, outputFile: outputFilename, generateValues: shouldGenerateMissingValues, readableIds: shouldUseReadableIds, skipHydrateRelationships, } = flags;
         const { path: entityTypePath } = args;
         // Global flags is a little hacky, but it was easier
         // and it doesn't see *that* bad because they are only valid
@@ -219,7 +220,7 @@ class CreateEntity extends basecommand_1.BaseCommand {
         IS_DRY_RUN = isDryRun;
         SHOULD_USE_READABLE_IDS = shouldUseReadableIds;
         SHOULD_SKIP_HYDRATE_RELATIONSHIPS = skipHydrateRelationships;
-        SHOULD_ONLY_USE_SPECIFIED_PROPERTIES = shouldOnlyUseSpecifiedProperties;
+        SHOULD_GENERATE_MISSING_VALUES = shouldGenerateMissingValues;
         const propertySpecificationArgs = argv
             .slice(1, argv.length)
             .filter(propertySpecifications_1.isValidPropertySpecification);
@@ -238,18 +239,24 @@ class CreateEntity extends basecommand_1.BaseCommand {
             ? (0, file_helpers_1.parseFileAsJsonArray)(inputFilename)
             : Array.from({ length: count || 1 }).fill({});
         NUM_ENTITIES_TO_CREATE = partialEntities.length;
+        const { root: entityName } = (0, types_2.parseTypePath)(entityTypePath);
         // Ensure we have the required properties for the entity type
-        if (SLUGS_THAT_MUST_BE_SPECIFIED_BY_TYPE_PATH[entityTypePath]) {
-            const requiredSlugs = SLUGS_THAT_MUST_BE_SPECIFIED_BY_TYPE_PATH[entityTypePath];
+        if (SLUGS_THAT_MUST_BE_SPECIFIED_BY_TYPE_PATH[entityName]) {
+            const requiredSlugs = SLUGS_THAT_MUST_BE_SPECIFIED_BY_TYPE_PATH[entityName];
             for (const slug of requiredSlugs) {
-                if (!propertySpecBySlug.has(slug)) {
-                    this.error(`Property '${slug}' must be specified for entity type '${entityTypePath}'.`);
+                // Check if the property is specified in command-line args
+                const isInCommandLineArgs = propertySpecBySlug.has(slug);
+                // Check if all entities from input file have this property
+                const allEntitiesHaveProperty = inputFilename
+                    ? partialEntities.every((entity) => entity[slug] !== undefined && entity[slug] !== null)
+                    : false;
+                if (!isInCommandLineArgs && !allEntitiesHaveProperty) {
+                    this.error(`Property '${slug}' must be specified for entity type '${entityName}'.`);
                 }
             }
         }
         try {
             const entitiesToCreate = await buildEntitiesToCreate(entityTypePath, partialEntities, propertySpecBySlug);
-            const { root: entityName } = (0, types_2.parseTypePath)(entityTypePath);
             const createdEntities = await createEntities(entityName, entitiesToCreate);
             if (outputFilename) {
                 fs_1.default.writeFileSync(outputFilename, JSON.stringify(createdEntities, null, 2));
@@ -294,15 +301,26 @@ async function buildEntitiesToCreate(entityTypePath, entities, propertySpecifica
     }));
     const limit = (0, p_limit_1.default)(30);
     await Promise.all(populatedEntities.map(async () => limit(() => throwIfEntityIsInvalid)));
+    // Skip system value generation unless -g flag is set (generateValues mode)
+    if (!SHOULD_GENERATE_MISSING_VALUES) {
+        console.log('Using only specified properties. Use --generate-values to auto-generate missing values.');
+        return populatedEntities;
+    }
     // Add system values if needed
     const { root } = (0, types_2.parseTypePath)(type.typePath);
     const valueFinderApplierForEntity = FIND_VALID_VALUE_MAP[root] || [];
     for (const { slug, findValidValuesFn, applyValueToEntityFn } of valueFinderApplierForEntity) {
-        // If the property is already specified, skip it unless it is a role for an option or family
+        // If the property is already specified in command-line args, skip it
         if (propertySpecificationBySlug?.has(slug)) {
             console.log(`Skipping property ${slug} because it is already specified.`);
             continue;
         }
+        // If all entities already have this property, skip finding values
+        const allEntitiesHaveProperty = populatedEntities.every((entity) => entity[slug] !== undefined && entity[slug] !== null);
+        if (allEntitiesHaveProperty) {
+            console.log(`Skipping property ${slug} because all entities already have this value.`);
+            continue;
+        }
         const values = await findValidValuesFn(populatedEntities, entities.length);
         if (values) {
             populatedEntities.forEach((e) => applyValueToEntityFn(e, values));
@@ -315,9 +333,9 @@ async function buildEntitiesToCreate(entityTypePath, entities, propertySpecifica
 }
 function createEntityWithPopulatedValues(type, typeReferencesCache, objectReferencesCache, propertySpecificationBySlug) {
     const roles = propertySpecificationBySlug?.get('roles');
-    const entity = SHOULD_ONLY_USE_SPECIFIED_PROPERTIES
-        ? {}
-        : pickRandomPropertyValues(type, objectReferencesCache, typeReferencesCache, roles);
+    const entity = SHOULD_GENERATE_MISSING_VALUES
+        ? pickRandomPropertyValues(type, objectReferencesCache, typeReferencesCache, roles)
+        : {};
     // Handle property specifications
     for (const [propertySlug, specifiedValue] of propertySpecificationBySlug.entries()) {
         const correspondingProperty = type.typeProperties.find((prop) => getPropertySlug(prop) === propertySlug);
@@ -452,7 +470,10 @@ function generateRandomNumber(min, max) {
     return Math.floor(Math.random() * (max - min + 1)) + min;
 }
 function generateRandomReadableString() {
-    return (0, unique_names_generator_1.uniqueNamesGenerator)({ dictionaries: [unique_names_generator_1.adjectives, unique_names_generator_1.animals, unique_names_generator_1.colors, unique_names_generator_1.animals, unique_names_generator_1.colors], length: 5 });
+    return (0, unique_names_generator_1.uniqueNamesGenerator)({
+        dictionaries: [unique_names_generator_1.adjectives, unique_names_generator_1.animals, unique_names_generator_1.colors, unique_names_generator_1.animals, unique_names_generator_1.colors],
+        length: 5,
+    });
 }
 function generateRandomDateString() {
     return new Date().toISOString();

package/dist/commands/entities/get.js

@@ -148,7 +148,15 @@ async function getEntityByTypePath(typePath, propertySpec, options = {}) {
     if (entityName === 'custom-entity' && !id) {
         criteria.typePath = typePath;
     }
-    return find(entityName, { id, skipHydrateRelationships, relations, propertySlugs, criteria, skip, take });
+    return find(entityName, {
+        id,
+        skipHydrateRelationships,
+        relations,
+        propertySlugs,
+        criteria,
+        skip,
+        take,
+    });
 }
 function convertPropertySpecIntoCriteria(propertySpec) {
     const criteria = {};
@@ -165,7 +173,7 @@ async function find(entityName, options = {}) {
         skipHydrateRelationships,
         relations,
         skip,
-        take
+        take,
     };
     if (propertySlugs && propertySlugs.length > 0) {
         queryOptions.customParams = { propertySlugs: propertySlugs.join(',') };

package/dist/commands/entities/update.js

@@ -37,7 +37,7 @@ class UpdateEntity extends basecommand_1.BaseCommand {
             char: 'F',
             description: 'Force update without validation. Internal use only',
             required: false,
-        })
+        }),
     };
     static args = {
         entityName: core_1.Args.string({
@@ -55,7 +55,7 @@ class UpdateEntity extends basecommand_1.BaseCommand {
         await (0, login_1.authUser)();
         const { args, argv } = await this.parse(UpdateEntity);
         const { id: specifiedId, entityName } = args;
-        const { dryRun: isDryRun, inputFile: inputFilename, skipHydrateRelationships, force } = this.flags;
+        const { dryRun: isDryRun, inputFile: inputFilename, skipHydrateRelationships, force, } = this.flags;
         const propertySpecArgs = argv.slice(1, argv.length).filter(propertySpecifications_1.isValidPropertySpecification);
         const propertySpec = (0, propertySpecifications_1.parsePropertySpecificationsIntoMap)(propertySpecArgs);
         if (inputFilename && specifiedId) {

package/dist/helpers/load/helpers.js

@@ -71,7 +71,7 @@ async function uploadFile(incomingFileName) {
 async function loadFile(config) {
     const entities = new sdk_1.Entities();
     // start a load job referencing the newly created file
-    logger_1.default.info(`Loading with config: ${config}`);
+    logger_1.default.info(`Loading with config: ${JSON.stringify(config, null, 2)}`);
     const loadJob = await entities.create({
         entityName: 'loader-process',
         object: {

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.6.0-alpha-5",
+  "version": "3.6.0-alpha-7",
   "commands": {
     "app:create": {
       "id": "app:create",
@@ -682,15 +682,15 @@
       "pluginType": "core",
       "aliases": [],
       "examples": [
-        "contrail entities create color -n=10 # creates 10 random colors",
-        "contrail entities create color # creates one item",
+        "contrail entities create color -g -n=10 # creates 10 random colors",
+        "contrail entities create color -- name=\"Electric Blue\" green=1 red=2 blue=3 # creates one color with specified properties only",
         "contrail entities create custom-entities:franchise",
         "contrail entities create project-item -n=1 -- projectId=abc # creates 10 project items within project ABC",
-        "contrail entities create color -r # creates a random color with a human readable ID",
-        "contrail entities create color -d # simulates the creation of a random color without actually creating it",
-        "contrail entities create custom-entity:franchise -s # creates a random color and the response does not contain hydrating relationships",
-        "contrail entities create color -p -- name=Electric Blue green=1 red=2 blue=3 # creates a color with specified properties",
-        "contrail entities create color -o /tmp/colors.json # creates a random color and saves the output to /tmp/colors.json"
+        "contrail entities create color -g -r # creates a random color with a human readable ID",
+        "contrail entities create color -d -- name=test # simulates the creation of a color without actually creating it",
+        "contrail entities create custom-entity:franchise -s # creates an entity and the response does not contain hydrating relationships",
+        "contrail entities create color -g -- name=Electric Blue # creates a color with the name specified and other properties auto-generated",
+        "contrail entities create color -o /tmp/colors.json -- name=Blue green=1 red=2 blue=3 # creates a color and saves the output to /tmp/colors.json"
       ],
       "flags": {
         "logLevel": {
@@ -740,7 +740,7 @@
           "name": "inputFile",
           "type": "option",
           "char": "i",
-          "description": "A file with a JSON array of objects where each object is one entity to create. Cannot be used with --count. Unless --precise is specified, any missing values will be populated with random values.",
+          "description": "A file with a JSON array of objects where each object is one entity to create. Cannot be used with --count. Unless --generate-values is specified, only the properties in the file will be used.",
           "required": false,
           "multiple": false
         },
@@ -752,11 +752,11 @@
           "required": false,
           "multiple": false
         },
-        "preciseProperties": {
-          "name": "preciseProperties",
+        "generateValues": {
+          "name": "generateValues",
           "type": "boolean",
-          "char": "p",
-          "description": "If true, does not generate random values for properties. All values must be specified.",
+          "char": "g",
+          "description": "If true, generates random values for properties that are not specified. By default, only specified properties are used.",
           "required": false,
           "allowNo": false
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "3.6.0-alpha-5",
+  "version": "3.6.0-alpha-7",
   "description": "VibeIQ's Contrail Platform CLI.",
   "bin": {
     "contrail-cli": "./bin/run",