@contrail/cli 3.4.0-alpha → 3.4.0

package/README.md

@@ -17,7 +17,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/3.4.0-alpha darwin-arm64 node-v22.19.0
+@contrail/cli/3.4.0 darwin-arm64 node-v20.9.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND
@@ -51,10 +51,6 @@ To get instructions on how to set up autocomplete for your shell, run `contrail
 * [`contrail config list`](#contrail-config-list)
 * [`contrail config set`](#contrail-config-set)
 * [`contrail config use [NAME]`](#contrail-config-use-name)
-* [`contrail entities create PATH`](#contrail-entities-create-path)
-* [`contrail entities delete ENTITYNAME`](#contrail-entities-delete-entityname)
-* [`contrail entities get TYPEPATH`](#contrail-entities-get-typepath)
-* [`contrail entities update ENTITYNAME ID`](#contrail-entities-update-entityname-id)
 * [`contrail file upload FILELOCATION CONTENTTYPE`](#contrail-file-upload-filelocation-contenttype)
 * [`contrail groups export`](#contrail-groups-export)
 * [`contrail groups import GROUPSFILE`](#contrail-groups-import-groupsfile)
@@ -539,151 +535,6 @@ EXAMPLES
   $ contrail config use demo-org
 ```
 
-## `contrail entities create PATH`
-
-(BETA) Create entities
-
-```
-USAGE
-  $ contrail entities create PATH [-l error|warn|info|debug] [-e true|false] [-n <value>] [-d] [-i <value>] [-o
-    <value>] [-p] [-r] [-s]
-
-ARGUMENTS
-  PATH  Path of the entity type to create
-
-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>
-  -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.
-  -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
-
-DESCRIPTION
-  (BETA) Create entities
-
-EXAMPLES
-  $ contrail entities create color -n=10 # creates 10 random colors
-
-  $ contrail entities create color # creates one item
-
-  $ 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 delete ENTITYNAME`
-
-(BETA) Delete an entity
-
-```
-USAGE
-  $ contrail entities delete ENTITYNAME [-l error|warn|info|debug] [-e true|false] [-d] [-i <value>] [--id <value>]
-
-ARGUMENTS
-  ENTITYNAME  The name of the entity type to delete
-
-FLAGS
-  -d, --dryRun                     If true, does not delete the entity but simulates the deletion
-  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
-                                   <options: true|false>
-  -i, --input=<value>              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.
-  -l, --logLevel=<option>          The Log Level
-                                   <options: error|warn|info|debug>
-  --id=<value>                     The unique identifier of the entity
-
-DESCRIPTION
-  (BETA) Delete an entity
-
-EXAMPLES
-  $ contrail entities delete color 123
-```
-
-## `contrail entities get TYPEPATH`
-
-(BETA) Get an entity
-
-```
-USAGE
-  $ contrail entities get TYPEPATH [-l error|warn|info|debug] [-e true|false] [-o <value>] [-s] [-r <value>] [-p
-    <value>] [-P] [-t <value>]
-
-ARGUMENTS
-  TYPEPATH  The name of the entity type to fetch
-
-FLAGS
-  -P, --paginated                  If true, fetches all entities in a paginated manner
-  -e, --alwaysConfirmEnv=<option>  [default: true] The Environment variables
-                                   <options: true|false>
-  -l, --logLevel=<option>          The Log Level
-                                   <options: error|warn|info|debug>
-  -o, --outputFile=<value>         File to save the output (optional)
-  -p, --propertySlugs=<value>      Comma-separated list of property slugs to include in the output
-  -r, --relations=<value>          Comma-separated list of relations to include in the output
-  -s, --skipHydrateRelationships   Skip hydrating relationships when fetching the entity
-  -t, --take=<value>               [default: 1000] Number of entities to fetch in a single request (default is 100)
-
-DESCRIPTION
-  (BETA) Get an entity
-
-EXAMPLES
-  $ contrail entities get color -- id=123
-
-  $ contrail entities get loader-processes -- createdOn=2025-09-15..2025-09-16
-
-  $ contrail entities get orders -- updatedAt=2025-09-15T04:00:00Z..
-
-  $ contrail entities get events -- timestamp=..2025-09-16T23:59:59Z
-```
-
-## `contrail entities update ENTITYNAME ID`
-
-(BETA) Update an entity
-
-```
-USAGE
-  $ contrail entities update ENTITYNAME ID [-l error|warn|info|debug] [-e true|false] [-s] [-d] [-i <value>]
-
-ARGUMENTS
-  ENTITYNAME  The name of the entity type to update
-  ID          The unique identifier of the entity
-
-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>
-  -i, --inputFile=<value>          File containing properties to update the entity (optional)
-  -l, --logLevel=<option>          The Log Level
-                                   <options: error|warn|info|debug>
-  -s, --skipHydrateRelationships   Skip hydrating relationships when updating the entity
-
-DESCRIPTION
-  (BETA) Update an entity
-
-EXAMPLES
-  $ contrail entities update color 123 -- name=obsidian hex=000000
-```
-
 ## `contrail file upload FILELOCATION CONTENTTYPE`
 
 Uploads a file to the VibeIQ platform
@@ -1507,7 +1358,7 @@ Upload Types Org. OptionSets are loaded from .yml files in the types directory.
 
 ```
 USAGE
-  $ contrail types uploadTypes [-l error|warn|info|debug] [-e true|false] [-d <value>]
+  $ contrail types uploadTypes [-l error|warn|info|debug] [-e true|false] [-d <value>] [-m]
 
 FLAGS
   -d, --dir=<value>                [default: .] The directory from which to export the option set data. Defaults to the
@@ -1516,6 +1367,8 @@ FLAGS
                                    <options: true|false>
   -l, --logLevel=<option>          The Log Level
                                    <options: error|warn|info|debug>
+  -m, --merge                      Merge types and type properties without deleting missing ones. Only adds/updates
+                                   those present in the source files.
 
 DESCRIPTION
   Upload Types Org. OptionSets are loaded from .yml files in the types directory.

package/dist/__mocks__/@contrail/sdk.d.ts

@@ -0,0 +1,123 @@
+export declare const BASE_MINIMAL_TYPE: {
+    pk: number;
+    id: string;
+    createdOn: string;
+    updatedOn: string;
+    createdById: string;
+    updatedById: string;
+    isArchived: boolean;
+    orgId: string;
+    slug: string;
+    label: string;
+    typePath: string;
+    typeRootId: string;
+    parentId: any;
+    typeProperties: any[];
+};
+export declare const BASE_TYPE_WITH_PROPERTIES: {
+    pk: number;
+    id: string;
+    createdOn: string;
+    updatedOn: string;
+    createdById: string;
+    updatedById: string;
+    isArchived: boolean;
+    orgId: string;
+    slug: string;
+    label: string;
+    typePath: string;
+    typeRootId: string;
+    parentId: any;
+    typePolicyIds: any[];
+    typePolicies: any[];
+    typeProperties: {
+        pk: number;
+        id: string;
+        createdOn: string;
+        updatedOn: string;
+        createdById: string;
+        updatedById: string;
+        isArchived: boolean;
+        orgId: string;
+        propertyType: string;
+        slug: string;
+        label: string;
+        editable: boolean;
+        core: boolean;
+        typePropertyOptionSetId: any;
+        typePropertyUserListId: any;
+        carryOverBehavior: any;
+        carryOverDefault: any;
+        copyBehavior: any;
+        copyDefault: any;
+        formula: any;
+        numberFormat: any;
+        referencedTypeRootSlug: any;
+        referencedTypeRole: any;
+        referencedTypeFilterProperties: any;
+        referencedTypeId: any;
+        referencedTypePath: any;
+        defaultValue: any;
+        propertyLevel: any;
+        formulaFunction: any;
+        validationFunction: any;
+        description: any;
+        apiDetails: any;
+        notes: any;
+        searchable: boolean;
+        isFederationProperty: boolean;
+        isUniqueProperty: boolean;
+        isUniquePropertyInFamily: boolean;
+        required: boolean;
+        sequenceSeedValue: number;
+        optionsSet: any;
+        inherited: boolean;
+        used: boolean;
+        overriddenPropertySlugs: any[];
+        typePropertyPolicyIds: any[];
+    }[];
+    typePropertyPolicies: any[];
+    typeRuleSets: any[];
+    typeOptionSetHierarchyLinks: any[];
+    relations: {
+        org: {
+            name: string;
+            entityType: string;
+            cardinality: string;
+        };
+        content: {
+            name: string;
+            entityType: string;
+            cardinality: string;
+        };
+        comments: {
+            name: string;
+            entityType: string;
+            cardinality: string;
+        };
+        createdBy: {
+            name: string;
+            entityType: string;
+            cardinality: string;
+        };
+        updatedBy: {
+            name: string;
+            entityType: string;
+            cardinality: string;
+        };
+        workspace: {
+            name: string;
+            entityType: string;
+            cardinality: string;
+        };
+        primaryViewable: {
+            name: string;
+            entityType: string;
+            cardinality: string;
+        };
+    };
+    typeInterfaces: {
+        slug: string;
+        label: string;
+    }[];
+};