@contrail/cli 3.2.0 → 3.3.0-alpha

package/README.md

@@ -17,7 +17,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/3.2.0 darwin-arm64 node-v20.18.0
+@contrail/cli/3.3.0-alpha darwin-arm64 node-v23.5.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND
@@ -51,6 +51,10 @@ 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)
@@ -535,6 +539,143 @@ 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, --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>
+  -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]
+
+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
+
+DESCRIPTION
+  (BETA) Get an entity
+
+EXAMPLES
+  $ contrail entities get color -- id=123
+```
+
+## `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]
+
+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>
+  -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

package/dist/api/types.d.ts

@@ -1,3 +1,5 @@
+import { TypeProperty as SDKTypeProperty } from '@contrail/types';
+import { PropertyLevel, PropertyType, Type } from '@contrail/types';
 export declare function getOptionSets(): Promise<any[]>;
 export declare function getUserLists(): Promise<any[]>;
 export declare function getOptionSetHierarchies(): Promise<any[]>;
@@ -9,3 +11,36 @@ export declare function getTypePropertyPolicies(): Promise<any[]>;
 export declare function getTypePropertyPolicyLinks(): Promise<any[]>;
 export declare function getTypePolicies(): Promise<any[]>;
 export declare function getTypePolicyLinks(): Promise<any[]>;
+type ColonDelimitedHelper<S extends string> = S extends `${infer Head}:${infer Tail}` ? `${Head}:${ColonDelimitedHelper<Tail>}` : S;
+export type ColonDelimited = ColonDelimitedHelper<string>;
+export type TypeWithProperties = Type & {
+    typeProperties: TypeProperty[];
+};
+export interface Option {
+    value: string;
+    display: string;
+    disabled?: boolean;
+}
+export interface TypeProperty extends SDKTypeProperty {
+    propertyType?: PropertyType;
+    referencedTypePath?: string;
+    referencedTypeRootSlug?: string;
+    propertyLevel?: PropertyLevel;
+}
+export interface TypePropertyOptionSet {
+    id?: string;
+    orgId?: string;
+    name: string;
+    slug: string;
+    optionSet: Option[];
+    isArchived?: boolean;
+}
+export type TypeReferencesCacheByPath = Map<string, TypeWithProperties>;
+export declare function getTypeByPath(path: ColonDelimited): Promise<TypeWithProperties>;
+export declare function buildLocalTypesCache(paths: ColonDelimited[]): Promise<TypeReferencesCacheByPath>;
+export declare function parseTypePath(path: ColonDelimited): {
+    root: string;
+    path: string;
+};
+export declare function getReferencedTypePaths(type: TypeWithProperties): ColonDelimited[];
+export {};

package/dist/api/types.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTypePolicyLinks = exports.getTypePolicies = exports.getTypePropertyPolicyLinks = exports.getTypePropertyPolicies = exports.getUsageInfo = exports.getRuleSetLinks = exports.getRuleSets = exports.getOptionSetHierarchyLinks = exports.getOptionSetHierarchies = exports.getUserLists = exports.getOptionSets = void 0;
+exports.getReferencedTypePaths = exports.parseTypePath = exports.buildLocalTypesCache = exports.getTypeByPath = exports.getTypePolicyLinks = exports.getTypePolicies = exports.getTypePropertyPolicyLinks = exports.getTypePropertyPolicies = exports.getUsageInfo = exports.getRuleSetLinks = exports.getRuleSets = exports.getOptionSetHierarchyLinks = exports.getOptionSetHierarchies = exports.getUserLists = exports.getOptionSets = void 0;
 const sdk_1 = require("@contrail/sdk");
+const types_1 = require("@contrail/types");
 async function getOptionSets() {
     return await new sdk_1.Entities().get({
         entityName: 'type-property-option-set',
@@ -77,3 +78,48 @@ async function getTypePolicyLinks() {
     });
 }
 exports.getTypePolicyLinks = getTypePolicyLinks;
+const TYPES_CACHE_BY_PATH = new Map();
+async function fetchTypeByPath(path) {
+    const { root } = parseTypePath(path);
+    const client = new sdk_1.Entities();
+    const type = await client.get({
+        entityName: 'type',
+        suffix: `roots/${root}/path/${path}`,
+        relations: ['typeProperties'],
+    });
+    return type;
+}
+async function getTypeByPath(path) {
+    if (TYPES_CACHE_BY_PATH.has(path)) {
+        return TYPES_CACHE_BY_PATH.get(path);
+    }
+    const type = await fetchTypeByPath(path);
+    TYPES_CACHE_BY_PATH.set(path, type);
+    return type;
+}
+exports.getTypeByPath = getTypeByPath;
+async function buildLocalTypesCache(paths) {
+    const types = await Promise.all(paths.map((path) => getTypeByPath(path)));
+    const newCache = types.reduce((acc, type) => {
+        acc.set(type.typePath, type);
+        return acc;
+    }, new Map());
+    return newCache;
+}
+exports.buildLocalTypesCache = buildLocalTypesCache;
+function parseTypePath(path) {
+    const parts = path.split(':').filter(Boolean);
+    if (parts.length === 0) {
+        throw new Error('Path cannot be empty');
+    }
+    const root = parts[0];
+    return { root, path };
+}
+exports.parseTypePath = parseTypePath;
+function getReferencedTypePaths(type) {
+    const properties = type.typeProperties || [];
+    return properties
+        .filter((prop) => prop.propertyType === types_1.PropertyType.TypeReference)
+        .map(({ referencedTypePath }) => referencedTypePath);
+}
+exports.getReferencedTypePaths = getReferencedTypePaths;

package/dist/basecommand.d.ts

@@ -8,7 +8,9 @@ export declare abstract class BaseCommand extends Command {
         logLevel: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
     };
     protected flags: any;
-    protected args: any;
+    protected args: {
+        [key: string]: any;
+    };
     init(): Promise<void>;
     setLogLevel(logLevel: string, config?: any): void;
     private confirmEnv;

package/dist/basecommand.js

@@ -17,7 +17,7 @@ class BaseCommand extends core_1.Command {
         ...baseFlags_1.baseFlags,
     };
     flags;
-    args;
+    args = {};
     async init() {
         await super.init();
         if (!this.ctor?.flags)

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

@@ -0,0 +1,37 @@
+import { PropertyLevel } from '@contrail/types';
+import { ColonDelimited, TypeProperty as ExtendedTypeProperty, TypeReferencesCacheByPath } from '../../api/types';
+import { TypeWithProperties } from '../../api/types';
+import { BaseCommand } from '../../basecommand';
+import { Role } from '../../helpers/entities';
+export default class CreateEntity extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        count: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        dryRun: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        input: 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>;
+        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>;
+        logLevel: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {
+        path: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
+    };
+    static strict: boolean;
+    run(): Promise<void>;
+}
+export type WithId = {
+    id: string;
+    [key: string]: any;
+};
+export type ObjectReferenceCache = Map<string, WithId>;
+type ObjectReferenceCachesByTypePath = Map<string, ObjectReferenceCache>;
+export declare function pickRandomValueForProperty(property: ExtendedTypeProperty, objectReferencesCache: ObjectReferenceCachesByTypePath, typeReferencesCache: TypeReferencesCacheByPath): number | string | string[] | boolean | null;
+export declare function getReferencedObjectPaths(type: TypeWithProperties): ColonDelimited[];
+export declare function buildObjectReferenceCache(entities: any[]): ObjectReferenceCache;
+export declare function selectRandomObject(cache: ObjectReferenceCache): WithId;
+export declare function doesPropertyLevelMatchRole(propertyLevel: PropertyLevel, role: Role): boolean;
+export {};