@contrail/cli 3.6.0-alpha-8-alpha.e4ae6bd → 3.6.0-alpha-8-alpha.7d24daa

package/README.md

@@ -17,7 +17,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/3.6.0-alpha-8-alpha.e4ae6bd linux-x64 node-v24.21.0
+@contrail/cli/3.6.0-alpha-8-alpha.7d24daa linux-x64 node-v24.21.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND
@@ -543,12 +543,12 @@ EXAMPLES
 
 ## `contrail entities create PATH`
 
-(BETA) Create entities
+Create entities
 
 ```
 USAGE
   $ contrail entities create PATH [-l error|warn|info|debug] [-e true|false] [-n <value>] [-d] [-i <value>] [-o
-    <value>] [-g] [-r] [-S]
+    <value>] [-g] [-r] [-S] [--suffix <value>]
 
 ARGUMENTS
   PATH  Path of the entity type to create
@@ -568,9 +568,11 @@ FLAGS
   -n, --count=<value>              Number of random entities to create
   -o, --outputFile=<value>         File to save the output (optional)
   -r, --readableIds                If true, uses readable IDs for the created entities
+  --suffix=<value>                 Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets
+                                   /<entities>/synchronous)
 
 DESCRIPTION
-  (BETA) Create entities
+  Create entities
 
 EXAMPLES
   $ contrail entities create color -g -n=10 # creates 10 random colors
@@ -594,11 +596,12 @@ EXAMPLES
 
 ## `contrail entities delete ENTITYNAME [IDS]`
 
-(BETA) Delete entities by id
+Delete entities by id
 
 ```
 USAGE
-  $ contrail entities delete ENTITYNAME [IDS] [-l error|warn|info|debug] [-e true|false] [-d] [-i <value>]
+  $ contrail entities delete ENTITYNAME [IDS] [-l error|warn|info|debug] [-e true|false] [-d] [-i <value>] [--suffix
+    <value>]
 
 ARGUMENTS
   ENTITYNAME  The name of the entity type to delete
@@ -612,9 +615,11 @@ FLAGS
                                    entity in the file.
   -l, --logLevel=<option>          The Log Level
                                    <options: error|warn|info|debug>
+  --suffix=<value>                 Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets
+                                   /<entities>/synchronous)
 
 DESCRIPTION
-  (BETA) Delete entities by id
+  Delete entities by id
 
 EXAMPLES
   $ contrail entities delete color 123
@@ -626,12 +631,12 @@ EXAMPLES
 
 ## `contrail entities get TYPEPATH [IDS]`
 
-(BETA) Get an entity
+Get an entity
 
 ```
 USAGE
   $ contrail entities get TYPEPATH [IDS] [-l error|warn|info|debug] [-e true|false] [-o <value>] [-p <value>] [-P]
-    [-s <value>] [-S] [-t <value>] [-r <value>]
+    [-s <value>] [-S] [-t <value>] [-r <value>] [--suffix <value>]
 
 ARGUMENTS
   TYPEPATH  The name of the entity type to fetch
@@ -649,9 +654,11 @@ FLAGS
   -r, --relations=<value>          Comma-separated list of relations to include in the output
   -s, --skip=<value>               Number of entities to skip (used with paginated fetch)
   -t, --take=<value>               Number of entities to fetch in a single request (default is 100)
+  --suffix=<value>                 Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets
+                                   /<entities>/synchronous)
 
 DESCRIPTION
-  (BETA) Get an entity
+  Get an entity
 
 EXAMPLES
   $ contrail entities get color 123
@@ -669,11 +676,12 @@ EXAMPLES
 
 ## `contrail entities update ENTITYNAME [IDS]`
 
-(BETA) Update an entity
+Update an entity
 
 ```
 USAGE
   $ contrail entities update ENTITYNAME [IDS] [-l error|warn|info|debug] [-e true|false] [-S] [-d] [-i <value>] [-F]
+    [--suffix <value>]
 
 ARGUMENTS
   ENTITYNAME  The name of the entity type to update
@@ -688,9 +696,11 @@ FLAGS
   -i, --inputFile=<value>          File containing properties to update the entity (optional)
   -l, --logLevel=<option>          The Log Level
                                    <options: error|warn|info|debug>
+  --suffix=<value>                 Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets
+                                   /<entities>/synchronous)
 
 DESCRIPTION
-  (BETA) Update an entity
+  Update an entity
 
 EXAMPLES
   $ contrail entities update color 123 -- name=obsidian hex=000000

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

@@ -14,6 +14,7 @@ export default class CreateEntity extends BaseCommand {
         generateValues: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         readableIds: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         skipHydrateRelationships: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        suffix: 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>;
     };

package/dist/commands/entities/create.js

@@ -145,7 +145,7 @@ const FIND_VALID_VALUE_MAP = {
     ],
 };
 class CreateEntity extends basecommand_1.BaseCommand {
-    static description = '(BETA) Create entities';
+    static description = 'Create entities';
     static examples = [
         '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',
@@ -200,6 +200,10 @@ class CreateEntity extends basecommand_1.BaseCommand {
             required: false,
             default: false,
         }),
+        suffix: core_1.Flags.string({
+            description: 'Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets /<entities>/synchronous)',
+            required: false,
+        }),
     };
     static args = {
         path: core_1.Args.string({
@@ -211,10 +215,9 @@ class CreateEntity extends basecommand_1.BaseCommand {
     static strict = false;
     async run() {
         (0, common_1.routeConsoleLogToStderr)();
-        console.error('🚨 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, generateValues: shouldGenerateMissingValues, readableIds: shouldUseReadableIds, skipHydrateRelationships, } = flags;
+        const { count, dryRun: isDryRun, inputFile: inputFilename, outputFile: outputFilename, generateValues: shouldGenerateMissingValues, readableIds: shouldUseReadableIds, skipHydrateRelationships, suffix, } = 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
@@ -260,7 +263,7 @@ class CreateEntity extends basecommand_1.BaseCommand {
         }
         try {
             const entitiesToCreate = await buildEntitiesToCreate(entityTypePath, partialEntities, propertySpecBySlug);
-            const summary = await createEntities(entityName, entitiesToCreate);
+            const summary = await createEntities(entityName, entitiesToCreate, suffix);
             if (outputFilename) {
                 fs_1.default.writeFileSync(outputFilename, JSON.stringify(summary, null, 2));
                 console.error(`Output saved to ${outputFilename}`);
@@ -295,13 +298,13 @@ function summarizeSettledCreates(inputs, settled) {
     return { created, failed };
 }
 exports.summarizeSettledCreates = summarizeSettledCreates;
-async function createEntities(entityName, entities) {
+async function createEntities(entityName, entities, suffix) {
     if (IS_DRY_RUN) {
         console.error(`Dry run mode: not creating entities, but simulating creation for ${entityName}`);
         return { created: entities, failed: [] };
     }
     const limit = (0, p_limit_1.default)(20);
-    const settled = await Promise.allSettled(entities.map(async (e) => limit(() => createEntity(entityName, e))));
+    const settled = await Promise.allSettled(entities.map(async (e) => limit(() => createEntity(entityName, e, suffix))));
     return summarizeSettledCreates(entities, settled);
 }
 async function buildEntitiesToCreate(entityTypePath, entities, propertySpecificationBySlug) {
@@ -541,12 +544,17 @@ function castValueToPropertyType(value, propertyType) {
     }
 }
 exports.castValueToPropertyType = castValueToPropertyType;
-async function createEntity(entityName, entity) {
+async function createEntity(entityName, entity, suffix) {
     const client = new sdk_1.Entities();
     const skipHydrateRelationships = SHOULD_SKIP_HYDRATE_RELATIONSHIPS;
-    if (entityName === 'assortment-item')
+    if (entityName === 'assortment-item' && !suffix)
         return (0, entities_1.createAssortmentItem)(entity, { skipHydrateRelationships }); // special case
-    const response = await client.create({ entityName, object: entity, skipHydrateRelationships });
+    const response = await client.create({
+        entityName,
+        object: entity,
+        skipHydrateRelationships,
+        suffix,
+    });
     return response;
 }
 function getReferencedObjectPaths(type) {

package/dist/commands/entities/create.spec.js

@@ -527,7 +527,7 @@ describe('castValueToPropertyType array coercion', () => {
         ]);
     });
     it('should keep a comma value literal on a multi-value property and warn with the repeated-key form', () => {
-        const consoleError = jest.spyOn(console, 'error').mockImplementation(() => { });
+        const consoleError = jest.spyOn(console, 'error').mockImplementation(() => undefined);
         expect((0, create_1.castValueToPropertyType)('option,family', types_1.PropertyType.MultiSelect)).toEqual([
             'option,family',
         ]);
@@ -535,7 +535,7 @@ describe('castValueToPropertyType array coercion', () => {
         consoleError.mockRestore();
     });
     it('should keep commas literal on string properties without warning', () => {
-        const consoleError = jest.spyOn(console, 'error').mockImplementation(() => { });
+        const consoleError = jest.spyOn(console, 'error').mockImplementation(() => undefined);
         expect((0, create_1.castValueToPropertyType)('my,name', types_1.PropertyType.String)).toBe('my,name');
         expect(consoleError).not.toHaveBeenCalled();
         consoleError.mockRestore();

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

@@ -5,6 +5,7 @@ export default class DeleteEntity extends BaseCommand {
     static flags: {
         dryRun: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         inputFile: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        suffix: 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>;
     };

package/dist/commands/entities/delete.js

@@ -10,7 +10,7 @@ const common_1 = require("../../common");
 const file_helpers_1 = require("../../helpers/file-helpers");
 let IS_DRY_RUN = false;
 class DeleteEntity extends basecommand_1.BaseCommand {
-    static description = '(BETA) Delete entities by id';
+    static description = 'Delete entities by id';
     static examples = [
         'contrail entities delete color 123',
         'contrail entities delete color id1 id2 id3',
@@ -26,10 +26,14 @@ class DeleteEntity extends basecommand_1.BaseCommand {
         }),
         inputFile: core_1.Flags.string({
             char: 'i',
-            description: 'A file with a JSON array of objects; only each object\'s id is used. Deletes every entity in the file.',
+            description: "A file with a JSON array of objects; only each object's id is used. Deletes every entity in the file.",
             required: false,
             multiple: false,
         }),
+        suffix: core_1.Flags.string({
+            description: 'Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets /<entities>/synchronous)',
+            required: false,
+        }),
     };
     static args = {
         entityName: core_1.Args.string({
@@ -44,11 +48,10 @@ class DeleteEntity extends basecommand_1.BaseCommand {
     static strict = false;
     async run() {
         (0, common_1.routeConsoleLogToStderr)();
-        console.error('🚨 This command is in BETA and may change or be removed at any time.');
         await (0, login_1.authUser)();
         const { args, flags, argv } = await this.parse(DeleteEntity);
         const { entityName } = args;
-        const { inputFile: inputFilename } = flags;
+        const { inputFile: inputFilename, suffix } = flags;
         if (flags.dryRun) {
             IS_DRY_RUN = true;
             console.error('Running in dry run mode. No entities will be deleted.');
@@ -72,7 +75,7 @@ class DeleteEntity extends basecommand_1.BaseCommand {
         }
         const ids = rowsWithId ? rowsWithId.map((item) => item.id) : positionalIds;
         try {
-            const response = await deleteEntityByIds(entityName, ids);
+            const response = await deleteEntityByIds(entityName, ids, suffix);
             if (IS_DRY_RUN) {
                 console.error('simulated deletion of entities:');
             }
@@ -91,12 +94,12 @@ class DeleteEntity extends basecommand_1.BaseCommand {
     }
 }
 exports.default = DeleteEntity;
-async function deleteEntityByIds(entityName, ids) {
+async function deleteEntityByIds(entityName, ids, suffix) {
     const idsDeleted = new Set();
     const idsNotFound = new Set();
     const idsErrored = new Set();
     const limit = (0, p_limit_1.default)(10);
-    const deletePromises = ids.map((id) => limit(() => deleteEntityById(entityName, id).then((entity) => {
+    const deletePromises = ids.map((id) => limit(() => deleteEntityById(entityName, id, suffix).then((entity) => {
         if (!entity) {
             idsNotFound.add(id);
             return null;
@@ -119,12 +122,12 @@ async function deleteEntityByIds(entityName, ids) {
         idsErrored: Array.from(idsErrored),
     };
 }
-async function deleteEntityById(entityName, id) {
+async function deleteEntityById(entityName, id, suffix) {
     const client = new sdk_1.Entities();
     if (IS_DRY_RUN) {
         return client.get({ entityName, id, ignore404: true }).catch(throwIfNot404);
     }
-    return client.delete({ entityName, id, ignore404: true }).catch(throwIfNot404);
+    return client.delete({ entityName, id, ignore404: true, suffix }).catch(throwIfNot404);
 }
 function throwIfNot404(e) {
     const { statusCode } = parseSDKErrorMessage(e);

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

@@ -10,6 +10,7 @@ export default class GetEntity extends BaseCommand {
         skipHydrateRelationships: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         take: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         relations: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        suffix: 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>;
     };

package/dist/commands/entities/get.js

@@ -13,7 +13,7 @@ const batchFetch_1 = require("../../helpers/entities/batchFetch");
 let SHOULD_USE_PAGINATED_FIND = false;
 let MAX_NUMBER_OF_ENTITIES_TO_FETCH = undefined;
 class GetEntity extends basecommand_1.BaseCommand {
-    static description = '(BETA) Get an entity';
+    static description = 'Get an entity';
     static examples = [
         'contrail entities get color 123',
         'contrail entities get color id1 id2 id3',
@@ -62,6 +62,10 @@ class GetEntity extends basecommand_1.BaseCommand {
             description: 'Comma-separated list of relations to include in the output',
             required: false,
         }),
+        suffix: core_1.Flags.string({
+            description: 'Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets /<entities>/synchronous)',
+            required: false,
+        }),
     };
     static args = {
         typePath: core_1.Args.string({
@@ -76,11 +80,10 @@ class GetEntity extends basecommand_1.BaseCommand {
     static strict = false;
     async run() {
         (0, common_1.routeConsoleLogToStderr)();
-        console.error('🚨 This command is in BETA and may change or be removed at any time.');
         await (0, login_1.authUser)();
         const { args, flags, argv } = await this.parse(GetEntity);
         const { typePath } = args;
-        const { outputFile, paginated: shouldUsePaginatedFind, propertySlugs, relations: relationString, skip, skipHydrateRelationships, take, } = flags;
+        const { outputFile, paginated: shouldUsePaginatedFind, propertySlugs, relations: relationString, skip, skipHydrateRelationships, suffix, take, } = flags;
         SHOULD_USE_PAGINATED_FIND = shouldUsePaginatedFind;
         MAX_NUMBER_OF_ENTITIES_TO_FETCH = take;
         if (MAX_NUMBER_OF_ENTITIES_TO_FETCH)
@@ -121,6 +124,7 @@ class GetEntity extends basecommand_1.BaseCommand {
                     criteria: convertPropertySpecIntoCriteria(propertySpecBySlug),
                     skipHydrateRelationships,
                     skip,
+                    suffix,
                     relations,
                     propertySlugs: propertySlugsArray,
                 });
@@ -143,6 +147,7 @@ class GetEntity extends basecommand_1.BaseCommand {
                     relations,
                     propertySlugs: propertySlugsArray,
                     skip,
+                    suffix,
                     take,
                 });
                 if (outputFile) {
@@ -161,7 +166,7 @@ class GetEntity extends basecommand_1.BaseCommand {
 }
 exports.default = GetEntity;
 async function getEntityByTypePath(typePath, propertySpec, options = {}) {
-    const { propertySlugs, relations, skipHydrateRelationships, skip, take } = options;
+    const { propertySlugs, relations, skipHydrateRelationships, skip, suffix, take } = options;
     const id = propertySpec?.get('id')?.toString() || undefined;
     const criteria = convertPropertySpecIntoCriteria(propertySpec || new Map());
     const { root: entityName } = (0, types_1.parseTypePath)(typePath);
@@ -175,6 +180,7 @@ async function getEntityByTypePath(typePath, propertySpec, options = {}) {
         propertySlugs,
         criteria,
         skip,
+        suffix,
         take,
     });
 }
@@ -187,19 +193,21 @@ function convertPropertySpecIntoCriteria(propertySpec) {
 }
 async function find(entityName, options = {}) {
     const client = new sdk_1.Entities();
-    const { criteria, id, propertySlugs, skipHydrateRelationships, relations, skip, take } = options;
+    const { criteria, id, propertySlugs, skipHydrateRelationships, relations, skip, suffix, take } = options;
     const queryOptions = {
         entityName,
         skipHydrateRelationships,
         relations,
         skip,
+        suffix,
         take,
     };
     if (propertySlugs && propertySlugs.length > 0) {
         queryOptions.customParams = { propertySlugs: propertySlugs.join(',') };
     }
     const payload = id ? { id, ...queryOptions } : { criteria, ...queryOptions };
-    if ((0, batchFetch_1.canBatchFetchEntity)(entityName)) {
+    // a suffix names a specific sub-route, so it always goes through the plain client
+    if ((0, batchFetch_1.canBatchFetchEntity)(entityName) && !suffix) {
         return (0, batchFetch_1.batchFetch)(entityName, payload);
     }
     else {

package/dist/commands/entities/grammar.spec.js

@@ -35,35 +35,41 @@ describe('entities command grammar: entities <verb> <typePath> [ID...]', () => {
         });
     });
     describe('positional id arguments', () => {
-        it('get accepts variadic positional ids', () => {
+        it('should accept variadic positional ids on get', () => {
             expect(get_1.default.strict).toBe(false);
             expect(get_1.default.args.ids).toBeDefined();
         });
-        it('update accepts variadic positional ids and has no single id arg', () => {
+        it('should accept variadic positional ids on update with no single id arg', () => {
             expect(update_1.default.strict).toBe(false);
             expect(update_1.default.args.ids).toBeDefined();
             expect(update_1.default.args.id).toBeUndefined();
         });
-        it('delete accepts variadic positional ids and has no --id flag', () => {
+        it('should accept variadic positional ids on delete with no --id flag', () => {
             expect(delete_1.default.strict).toBe(false);
             expect(delete_1.default.args.ids).toBeDefined();
             expect(delete_1.default.flags.id).toBeUndefined();
         });
     });
     describe('flag alignment across verbs', () => {
-        it('the input file is -i, --inputFile on every verb that accepts one', () => {
+        it('should name the input file -i, --inputFile on every verb that accepts one', () => {
             expect(create_1.default.flags.inputFile.char).toBe('i');
             expect(update_1.default.flags.inputFile.char).toBe('i');
             expect(delete_1.default.flags.inputFile.char).toBe('i');
             expect(delete_1.default.flags.input).toBeUndefined();
         });
-        it('skipHydrateRelationships is -S on every verb', () => {
+        it('should map skipHydrateRelationships to -S on every verb', () => {
             expect(create_1.default.flags.skipHydrateRelationships.char).toBe('S');
             expect(get_1.default.flags.skipHydrateRelationships.char).toBe('S');
             expect(update_1.default.flags.skipHydrateRelationships.char).toBe('S');
         });
-        it('get keeps -s for --skip', () => {
+        it('should keep -s for --skip on get', () => {
             expect(get_1.default.flags.skip.char).toBe('s');
         });
+        it('should expose --suffix on every verb to reach entity sub-routes', () => {
+            expect(create_1.default.flags.suffix).toBeDefined();
+            expect(get_1.default.flags.suffix).toBeDefined();
+            expect(update_1.default.flags.suffix).toBeDefined();
+            expect(delete_1.default.flags.suffix).toBeDefined();
+        });
     });
 });

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

@@ -7,6 +7,7 @@ export default class UpdateEntity 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>;
         force: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        suffix: 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>;
     };

package/dist/commands/entities/update.js

@@ -11,7 +11,7 @@ const common_1 = require("../../common");
 const propertySpecifications_1 = require("../../helpers/propertySpecifications/propertySpecifications");
 const file_helpers_1 = require("../../helpers/file-helpers");
 class UpdateEntity extends basecommand_1.BaseCommand {
-    static description = '(BETA) Update an entity';
+    static description = 'Update an entity';
     static examples = [
         'contrail entities update color 123 -- name=obsidian hex=000000',
         'contrail entities update item id1 id2 id3 -- status=archived # apply the same change to several entities',
@@ -41,6 +41,10 @@ class UpdateEntity extends basecommand_1.BaseCommand {
             description: 'Force update without validation. Internal use only',
             required: false,
         }),
+        suffix: core_1.Flags.string({
+            description: 'Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets /<entities>/synchronous)',
+            required: false,
+        }),
     };
     static args = {
         entityName: core_1.Args.string({
@@ -55,11 +59,10 @@ class UpdateEntity extends basecommand_1.BaseCommand {
     static strict = false;
     async run() {
         (0, common_1.routeConsoleLogToStderr)();
-        console.error('🚨 This command is in BETA and may change or be removed at any time.');
         await (0, login_1.authUser)();
         const { args, argv } = await this.parse(UpdateEntity);
         const { entityName } = args;
-        const { dryRun: isDryRun, inputFile: inputFilename, skipHydrateRelationships, force, } = this.flags;
+        const { dryRun: isDryRun, inputFile: inputFilename, skipHydrateRelationships, suffix, force, } = this.flags;
         const { ids: positionalIds, specs } = (0, propertySpecifications_1.partitionIdsAndSpecs)(argv.slice(1));
         const propertySpec = (0, propertySpecifications_1.parsePropertySpecificationsIntoMap)(specs);
         if (propertySpec.has('id') || propertySpec.has('ids')) {
@@ -89,7 +92,11 @@ class UpdateEntity extends basecommand_1.BaseCommand {
             const id = entity.id;
             return isDryRun
                 ? mockUpdateById(entityName, id, newEntityState, { skipHydrateRelationships })
-                : updateEntityById(entityName, id, newEntityState, { skipHydrateRelationships, force });
+                : updateEntityById(entityName, id, newEntityState, {
+                    skipHydrateRelationships,
+                    suffix,
+                    force,
+                });
         }
         try {
             const limit = (0, p_limit_1.default)(20);
@@ -131,8 +138,8 @@ function summarizeSettledUpdates(inputs, settled, skipped) {
 exports.summarizeSettledUpdates = summarizeSettledUpdates;
 async function updateEntityById(entityName, id, changes, options = {}) {
     const client = new sdk_1.Entities();
-    const { skipHydrateRelationships, force } = options;
-    return client.update({ entityName, id, object: changes, skipHydrateRelationships });
+    const { skipHydrateRelationships, suffix, force } = options;
+    return client.update({ entityName, id, object: changes, skipHydrateRelationships, suffix });
 }
 async function mockUpdateById(entityName, id, changes, options = {}) {
     const client = new sdk_1.Entities();

package/dist/helpers/propertySpecifications/propertySpecifications.d.ts

@@ -31,8 +31,7 @@ export declare function parsePropertySpecification(spec: PropertySpecificationSt
 export declare function parsePropertySpecificationsIntoMap(propertySpecifications: PropertySpecificationString[]): PropertySpecificationBySlug;
 /**
  * Splits command argv tokens (after the typePath) into positional ids and
- * property specifications. A token containing '=' is a property specification
- * candidate; every other token is an id.
+ * property specifications.
  */
 export declare function partitionIdsAndSpecs(tokens: string[]): {
     ids: string[];

package/dist/helpers/propertySpecifications/propertySpecifications.js

@@ -71,8 +71,6 @@ function parsePropertySpecificationsIntoMap(propertySpecifications) {
             propertySpecBySlug.set(slug, idsArray);
             continue;
         }
-        // Repeating a key accumulates values into an array; commas in every other
-        // value are literal.
         const existing = propertySpecBySlug.get(slug);
         if (propertySpecBySlug.has(slug) && existing !== undefined && value !== undefined) {
             propertySpecBySlug.set(slug, Array.isArray(existing) ? [...existing, value] : [existing, value]);
@@ -85,8 +83,7 @@ function parsePropertySpecificationsIntoMap(propertySpecifications) {
 exports.parsePropertySpecificationsIntoMap = parsePropertySpecificationsIntoMap;
 /**
  * Splits command argv tokens (after the typePath) into positional ids and
- * property specifications. A token containing '=' is a property specification
- * candidate; every other token is an id.
+ * property specifications.
  */
 function partitionIdsAndSpecs(tokens) {
     return {

package/dist/logger.spec.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const logger_1 = tslib_1.__importDefault(require("./logger"));
 describe('logger', () => {
-    it('writes every level to stderr so stdout carries only command output', () => {
+    it('should write every log level to stderr so stdout carries only command output', () => {
         const consoleTransport = logger_1.default.transports[0];
         for (const level of ['error', 'warn', 'info', 'debug']) {
             expect(consoleTransport.stderrLevels[level]).toBe(true);

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.6.0-alpha-8-alpha.e4ae6bd",
+  "version": "3.6.0-alpha-8-alpha.7d24daa",
   "commands": {
     "app:create": {
       "id": "app:create",
@@ -675,7 +675,7 @@
     },
     "entities:create": {
       "id": "entities:create",
-      "description": "(BETA) Create entities",
+      "description": "Create entities",
       "strict": false,
       "pluginName": "@contrail/cli",
       "pluginAlias": "@contrail/cli",
@@ -775,6 +775,13 @@
           "description": "If true, does not hydrate relationships for the created entities",
           "required": false,
           "allowNo": false
+        },
+        "suffix": {
+          "name": "suffix",
+          "type": "option",
+          "description": "Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets /<entities>/synchronous)",
+          "required": false,
+          "multiple": false
         }
       },
       "args": {
@@ -787,7 +794,7 @@
     },
     "entities:delete": {
       "id": "entities:delete",
-      "description": "(BETA) Delete entities by id",
+      "description": "Delete entities by id",
       "strict": false,
       "pluginName": "@contrail/cli",
       "pluginAlias": "@contrail/cli",
@@ -841,6 +848,13 @@
           "description": "A file with a JSON array of objects; only each object's id is used. Deletes every entity in the file.",
           "required": false,
           "multiple": false
+        },
+        "suffix": {
+          "name": "suffix",
+          "type": "option",
+          "description": "Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets /<entities>/synchronous)",
+          "required": false,
+          "multiple": false
         }
       },
       "args": {
@@ -858,7 +872,7 @@
     },
     "entities:get": {
       "id": "entities:get",
-      "description": "(BETA) Get an entity",
+      "description": "Get an entity",
       "strict": false,
       "pluginName": "@contrail/cli",
       "pluginAlias": "@contrail/cli",
@@ -955,6 +969,13 @@
           "description": "Comma-separated list of relations to include in the output",
           "required": false,
           "multiple": false
+        },
+        "suffix": {
+          "name": "suffix",
+          "type": "option",
+          "description": "Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets /<entities>/synchronous)",
+          "required": false,
+          "multiple": false
         }
       },
       "args": {
@@ -972,7 +993,7 @@
     },
     "entities:update": {
       "id": "entities:update",
-      "description": "(BETA) Update an entity",
+      "description": "Update an entity",
       "strict": false,
       "pluginName": "@contrail/cli",
       "pluginAlias": "@contrail/cli",
@@ -1042,6 +1063,13 @@
           "description": "Force update without validation. Internal use only",
           "required": false,
           "allowNo": false
+        },
+        "suffix": {
+          "name": "suffix",
+          "type": "option",
+          "description": "Append a sub-route to the entity endpoint (e.g. --suffix=synchronous targets /<entities>/synchronous)",
+          "required": false,
+          "multiple": false
         }
       },
       "args": {

package/package.json

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