@contrail/cli 3.6.0-alpha-8-alpha.8cae9b1 → 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.8cae9b1 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
@@ -548,7 +548,7 @@ 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,6 +568,8 @@ 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
   Create entities
@@ -598,7 +600,8 @@ 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,6 +615,8 @@ 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
   Delete entities by id
@@ -631,7 +636,7 @@ 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,6 +654,8 @@ 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
   Get an entity
@@ -674,6 +681,7 @@ 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,6 +696,8 @@ 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
   Update an entity

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

@@ -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({
@@ -213,7 +217,7 @@ class CreateEntity extends basecommand_1.BaseCommand {
         (0, common_1.routeConsoleLogToStderr)();
         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
@@ -259,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}`);
@@ -294,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) {
@@ -540,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/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

@@ -30,6 +30,10 @@ class DeleteEntity extends basecommand_1.BaseCommand {
             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({
@@ -47,7 +51,7 @@ class DeleteEntity extends basecommand_1.BaseCommand {
         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.');
@@ -71,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:');
             }
@@ -90,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;
@@ -118,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

@@ -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({
@@ -79,7 +83,7 @@ class GetEntity extends basecommand_1.BaseCommand {
         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)
@@ -120,6 +124,7 @@ class GetEntity extends basecommand_1.BaseCommand {
                     criteria: convertPropertySpecIntoCriteria(propertySpecBySlug),
                     skipHydrateRelationships,
                     skip,
+                    suffix,
                     relations,
                     propertySlugs: propertySlugsArray,
                 });
@@ -142,6 +147,7 @@ class GetEntity extends basecommand_1.BaseCommand {
                     relations,
                     propertySlugs: propertySlugsArray,
                     skip,
+                    suffix,
                     take,
                 });
                 if (outputFile) {
@@ -160,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);
@@ -174,6 +180,7 @@ async function getEntityByTypePath(typePath, propertySpec, options = {}) {
         propertySlugs,
         criteria,
         skip,
+        suffix,
         take,
     });
 }
@@ -186,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

@@ -65,5 +65,11 @@ describe('entities command grammar: entities <verb> <typePath> [ID...]', () => {
         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

@@ -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({
@@ -58,7 +62,7 @@ class UpdateEntity extends basecommand_1.BaseCommand {
         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')) {
@@ -88,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);
@@ -130,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/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.6.0-alpha-8-alpha.8cae9b1",
+  "version": "3.6.0-alpha-8-alpha.7d24daa",
   "commands": {
     "app:create": {
       "id": "app:create",
@@ -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": {
@@ -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": {
@@ -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": {
@@ -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.8cae9b1",
+  "version": "3.6.0-alpha-8-alpha.7d24daa",
   "description": "VibeIQ's Contrail Platform CLI.",
   "bin": {
     "contrail-cli": "./bin/run",