@contrail/cli 3.6.0-alpha-2 → 3.6.0-alpha-3

package/README.md

@@ -17,7 +17,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/3.6.0-alpha-2 darwin-arm64 node-v22.19.0
+@contrail/cli/3.6.0-alpha-3 darwin-arm64 node-v22.19.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND
@@ -683,7 +683,7 @@ DESCRIPTION
 EXAMPLES
   $ contrail entities update color 123 -- name=obsidian hex=000000
 
-  $ contrail entities update color 123 -- description= notes='""' data=null # Unset description, empty notes, null data
+  $ contrail entities update color 123 -- description= notes='""' # Unset description, set notes to empty string
 ```
 
 ## `contrail file upload FILELOCATION CONTENTTYPE`

package/dist/commands/entities/get.js

@@ -8,6 +8,7 @@ const sdk_1 = require("@contrail/sdk");
 const login_1 = require("../../auth/login");
 const types_1 = require("../../api/types");
 const propertySpecifications_1 = require("../../helpers/propertySpecifications/propertySpecifications");
+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 {
@@ -162,7 +163,13 @@ async function find(entityName, options = {}) {
     if (propertySlugs && propertySlugs.length > 0) {
         queryOptions.customParams = { propertySlugs: propertySlugs.join(',') };
     }
-    return id ? client.get({ id, ...queryOptions }) : client.get({ criteria, ...queryOptions });
+    const payload = id ? { id, ...queryOptions } : { criteria, ...queryOptions };
+    if ((0, batchFetch_1.canBatchFetchEntity)(entityName)) {
+        return (0, batchFetch_1.batchFetch)(entityName, payload);
+    }
+    else {
+        return client.get(payload);
+    }
 }
 async function* streamPaginatedFind(typePath, options = {}) {
     const client = new sdk_1.Entities();

package/dist/commands/entities/update.js

@@ -12,7 +12,7 @@ class UpdateEntity extends basecommand_1.BaseCommand {
     static description = '(BETA) Update an entity';
     static examples = [
         'contrail entities update color 123 -- name=obsidian hex=000000',
-        'contrail entities update color 123 -- description= notes=\'""\' data=null # Unset description, empty notes, null data',
+        'contrail entities update color 123 -- description= notes=\'""\' # Unset description, set notes to empty string',
     ];
     static flags = {
         ...basecommand_1.BaseCommand.baseFlags,

package/dist/helpers/entities/batchFetch.d.ts

@@ -1,7 +1,7 @@
-import { AssortmentItem, Item, ProjectItem } from '@contrail/entity-types';
+import { AssortmentItem, ProjectItem } from '@contrail/entity-types';
 import { EntitiesClientGetOptions } from '@contrail/sdk';
+export declare function canBatchFetchEntity(entityName: string): entityName is keyof BatchFetchableEntityMap;
 export interface BatchFetchableEntityMap {
-    item: Item;
     'project-item': ProjectItem;
     'assortment-item': AssortmentItem;
 }

package/dist/helpers/entities/batchFetch.js

@@ -1,8 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.batchFetch = void 0;
+exports.batchFetch = exports.canBatchFetchEntity = void 0;
 const sdk_1 = require("@contrail/sdk");
 const util_1 = require("@contrail/util");
+// Maps entity names to their types for batch fetching.
+// This allows for type-safe batch fetching of entities
+// such that the Type returned always matches the entity name.
+const BATCH_FETCHABLE_ENTITIES = ['assortment-item', 'project-item'];
+function canBatchFetchEntity(entityName) {
+    return BATCH_FETCHABLE_ENTITIES.includes(entityName);
+}
+exports.canBatchFetchEntity = canBatchFetchEntity;
 async function batchFetch(entityName, options) {
     const response = await requestBatchFetch(entityName, options);
     return parseBatchFetchResponse(response);

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

@@ -10,24 +10,22 @@
  *
  * It is typically used as the argv in a command.
  *
- * Special handling for empty values and null:
+ * Special handling for empty values:
  * - slug= (empty value) → property is set to undefined (unset)
  * - slug='""' or slug="''" → property is set to empty string ""
- * - slug=null → property is set to null
- * - slug="null" → property is set to the string "null"
  *
  * Examples:
  *
  * contrail entities get color -- id=123
  * contrail entities update color 123 -- name=obsidian hex=000000
- * contrail entities update color 123 -- description= notes='""' data=null
+ * contrail entities update color 123 -- description= notes='""'
  * contrail entities get loader-processes -- createdOn=2025-09-15..2025-09-16
  */
 export type PropertySpecification = {
     slug: string;
-    value: string | undefined | null;
+    value: string | undefined;
 };
-export type PropertySpecificationBySlug = Map<string, string | number | string[] | number[] | undefined | null>;
+export type PropertySpecificationBySlug = Map<string, string | number | string[] | number[] | undefined>;
 export type PropertySpecificationString = `${string}=${string}`;
 export declare function parsePropertySpecification(spec: PropertySpecificationString): PropertySpecification;
 export declare function parsePropertySpecificationsIntoMap(propertySpecifications: PropertySpecificationString[]): PropertySpecificationBySlug;

package/dist/helpers/propertySpecifications/propertySpecifications.js

@@ -11,17 +11,15 @@
  *
  * It is typically used as the argv in a command.
  *
- * Special handling for empty values and null:
+ * Special handling for empty values:
  * - slug= (empty value) → property is set to undefined (unset)
  * - slug='""' or slug="''" → property is set to empty string ""
- * - slug=null → property is set to null
- * - slug="null" → property is set to the string "null"
  *
  * Examples:
  *
  * contrail entities get color -- id=123
  * contrail entities update color 123 -- name=obsidian hex=000000
- * contrail entities update color 123 -- description= notes='""' data=null
+ * contrail entities update color 123 -- description= notes='""'
  * contrail entities get loader-processes -- createdOn=2025-09-15..2025-09-16
  */
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -40,11 +38,9 @@ function parsePropertySpecification(spec) {
     if (!slug) {
         throw new Error(`Invalid property specification: ${spec}`);
     }
-    // Handle special cases for empty strings and null:
+    // Handle special cases for empty strings:
     // - x= means undefined (unset the property)
     // - x='""' or x="''" means empty string ""
-    // - x=null means null value
-    // - x="null" means the string "null"
     let finalValue;
     if (value === '') {
         finalValue = undefined;
@@ -52,9 +48,6 @@ function parsePropertySpecification(spec) {
     else if (value === DOUBLE_QUOTED_EMPTY || value === SINGLE_QUOTED_EMPTY) {
         finalValue = '';
     }
-    else if (value === 'null') {
-        finalValue = null;
-    }
     else {
         finalValue = value;
     }

package/dist/helpers/propertySpecifications/propertySpecifications.spec.js

@@ -78,28 +78,6 @@ describe('parsePropertySpecification', () => {
             value: '',
         });
     });
-    it('should parse property specification with null value', () => {
-        const spec = 'description=null';
-        const result = (0, propertySpecifications_1.parsePropertySpecification)(spec);
-        expect(result).toEqual({
-            slug: 'description',
-            value: null,
-        });
-    });
-    it('should distinguish between null and the string "null"', () => {
-        const nullSpec = 'field=null';
-        const stringNullSpec = 'field="null"';
-        const nullResult = (0, propertySpecifications_1.parsePropertySpecification)(nullSpec);
-        const stringNullResult = (0, propertySpecifications_1.parsePropertySpecification)(stringNullSpec);
-        expect(nullResult).toEqual({
-            slug: 'field',
-            value: null,
-        });
-        expect(stringNullResult).toEqual({
-            slug: 'field',
-            value: '"null"',
-        });
-    });
     it('should throw error for spec without equals sign', () => {
         const spec = 'invalidspec';
         expect(() => (0, propertySpecifications_1.parsePropertySpecification)(spec)).toThrow('Invalid property specification: invalidspec');
@@ -175,23 +153,9 @@ describe('parsePropertySpecificationsIntoMap', () => {
         const result = (0, propertySpecifications_1.parsePropertySpecificationsIntoMap)(specs);
         expect(result.get('name')).toBe('john');
         expect(result.get('description')).toBeUndefined();
-        expect(result.get('notes')).toBe('');
+        expect(result.get('notes')).toBe(''); // Empty quotes are converted to empty string
         expect(result.size).toBe(3);
     });
-    it('should handle property specifications with null values', () => {
-        const specs = [
-            'name=john',
-            'description=null',
-            'notes="null"',
-            'empty=',
-        ];
-        const result = (0, propertySpecifications_1.parsePropertySpecificationsIntoMap)(specs);
-        expect(result.get('name')).toBe('john');
-        expect(result.get('description')).toBeNull();
-        expect(result.get('notes')).toBe('"null"');
-        expect(result.get('empty')).toBeUndefined();
-        expect(result.size).toBe(4);
-    });
     it('should throw error for invalid property specifications', () => {
         const specs = [
             'name=john',
@@ -278,21 +242,13 @@ describe('integration tests', () => {
         const quotedSpecs = ['description=""'];
         const quotedMap = (0, propertySpecifications_1.parsePropertySpecificationsIntoMap)(quotedSpecs);
         expect(quotedMap.get('description')).toBe(''); // Quoted empty = empty string
-        // Test case 3: Mixed usage with null
-        const mixedSpecs = [
-            'name=test',
-            'description=',
-            'notes=""',
-            'data=null',
-            'status="null"',
-        ];
+        // Test case 3: Mixed usage
+        const mixedSpecs = ['name=test', 'description=', 'notes=""'];
         const mixedMap = (0, propertySpecifications_1.parsePropertySpecificationsIntoMap)(mixedSpecs);
         expect(mixedMap.get('name')).toBe('test');
         expect(mixedMap.get('description')).toBeUndefined(); // Unset
         expect(mixedMap.get('notes')).toBe(''); // Empty string
-        expect(mixedMap.get('data')).toBeNull(); // null value
-        expect(mixedMap.get('status')).toBe('"null"'); // String "null"
-        expect(mixedMap.size).toBe(5);
+        expect(mixedMap.size).toBe(3);
     });
 });
 describe('edge cases and limitations', () => {
@@ -362,20 +318,4 @@ describe('edge cases and limitations', () => {
             value: 'value',
         });
     });
-    it('should document all special value types', () => {
-        // This test documents all the special value types and their parsing behavior
-        const specs = [
-            { input: 'a=value', expected: 'value', description: 'regular string' },
-            { input: 'b=', expected: undefined, description: 'undefined (unset)' },
-            { input: 'c=""', expected: '', description: 'empty string' },
-            { input: 'd=null', expected: null, description: 'null value' },
-            { input: 'e="null"', expected: '"null"', description: 'string "null"' },
-            { input: 'f=123', expected: '123', description: 'numeric string' },
-            { input: 'g=true', expected: 'true', description: 'boolean string' },
-        ];
-        for (const { input, expected } of specs) {
-            const result = (0, propertySpecifications_1.parsePropertySpecification)(input);
-            expect(result.value).toBe(expected);
-        }
-    });
 });

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.6.0-alpha-2",
+  "version": "3.6.0-alpha-3",
   "commands": {
     "app:create": {
       "id": "app:create",
@@ -964,7 +964,7 @@
       "aliases": [],
       "examples": [
         "contrail entities update color 123 -- name=obsidian hex=000000",
-        "contrail entities update color 123 -- description= notes='\"\"' data=null # Unset description, empty notes, null data"
+        "contrail entities update color 123 -- description= notes='\"\"' # Unset description, set notes to empty string"
       ],
       "flags": {
         "logLevel": {

package/package.json

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