@contrail/cli 3.3.3 → 3.5.0-alpha

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/README.md +150 -1
  2. package/dist/api/types.d.ts +35 -0
  3. package/dist/api/types.js +47 -1
  4. package/dist/auth/login.js +0 -8
  5. package/dist/basecommand.d.ts +3 -1
  6. package/dist/basecommand.js +1 -1
  7. package/dist/commands/app/extension/deploy.js +2 -4
  8. package/dist/commands/entities/create.d.ts +37 -0
  9. package/dist/commands/entities/create.js +555 -0
  10. package/dist/commands/entities/create.spec.d.ts +1 -0
  11. package/dist/commands/entities/create.spec.js +514 -0
  12. package/dist/commands/entities/delete.d.ts +16 -0
  13. package/dist/commands/entities/delete.js +118 -0
  14. package/dist/commands/entities/get.d.ts +20 -0
  15. package/dist/commands/entities/get.js +204 -0
  16. package/dist/commands/entities/update.d.ts +18 -0
  17. package/dist/commands/entities/update.js +116 -0
  18. package/dist/commands/types/uploadUsageInfo.js +2 -14
  19. package/dist/common.d.ts +1 -1
  20. package/dist/helpers/app/app-deployer.js +4 -8
  21. package/dist/helpers/app/extension-package-deployer.js +1 -1
  22. package/dist/helpers/config/config.js +3 -3
  23. package/dist/helpers/entities/assortment-items.d.ts +10 -0
  24. package/dist/helpers/entities/assortment-items.js +84 -0
  25. package/dist/helpers/entities/batchFetch.d.ts +8 -0
  26. package/dist/helpers/entities/batchFetch.js +41 -0
  27. package/dist/helpers/entities/index.d.ts +3 -0
  28. package/dist/helpers/entities/index.js +6 -0
  29. package/dist/helpers/entities/items.d.ts +10 -0
  30. package/dist/helpers/entities/items.js +102 -0
  31. package/dist/helpers/entities/project-items.d.ts +3 -0
  32. package/dist/helpers/entities/project-items.js +65 -0
  33. package/dist/helpers/file-helpers.d.ts +1 -0
  34. package/dist/helpers/file-helpers.js +19 -1
  35. package/dist/helpers/propertySpecifications/dateRanges.d.ts +38 -0
  36. package/dist/helpers/propertySpecifications/dateRanges.js +89 -0
  37. package/dist/helpers/propertySpecifications/dateRanges.spec.d.ts +1 -0
  38. package/dist/helpers/propertySpecifications/dateRanges.spec.js +95 -0
  39. package/dist/helpers/propertySpecifications/propertySpecifications.d.ts +27 -0
  40. package/dist/helpers/propertySpecifications/propertySpecifications.js +70 -0
  41. package/dist/helpers/propertySpecifications/propertySpecifications.spec.d.ts +1 -0
  42. package/dist/helpers/propertySpecifications/propertySpecifications.spec.js +266 -0
  43. package/dist/helpers/types/type-uploader.js +0 -7
  44. package/dist/interfaces.d.ts +0 -1
  45. package/dist/templates/typescript/README.md +1 -3
  46. package/dist/templates/typescript/assets/sample.json +1 -1
  47. package/dist/templates/typescript/eslintrc.json +4 -1
  48. package/dist/templates/typescript/tsconfig.json +21 -5
  49. package/oclif.manifest.json +361 -1
  50. package/package.json +6 -5
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "3.3.3",
2
+ "version": "3.5.0-alpha",
3
3
  "commands": {
4
4
  "app:create": {
5
5
  "id": "app:create",
@@ -672,6 +672,366 @@
672
672
  }
673
673
  }
674
674
  },
675
+ "entities:create": {
676
+ "id": "entities:create",
677
+ "description": "(BETA) Create entities",
678
+ "strict": false,
679
+ "pluginName": "@contrail/cli",
680
+ "pluginAlias": "@contrail/cli",
681
+ "pluginType": "core",
682
+ "aliases": [],
683
+ "examples": [
684
+ "contrail entities create color -n=10 # creates 10 random colors",
685
+ "contrail entities create color # creates one item",
686
+ "contrail entities create custom-entities:franchise",
687
+ "contrail entities create project-item -n=1 -- projectId=abc # creates 10 project items within project ABC",
688
+ "contrail entities create color -r # creates a random color with a human readable ID",
689
+ "contrail entities create color -d # simulates the creation of a random color without actually creating it",
690
+ "contrail entities create custom-entity:franchise -s # creates a random color and the response does not contain hydrating relationships",
691
+ "contrail entities create color -p -- name=Electric Blue green=1 red=2 blue=3 # creates a color with specified properties",
692
+ "contrail entities create color -o /tmp/colors.json # creates a random color and saves the output to /tmp/colors.json"
693
+ ],
694
+ "flags": {
695
+ "logLevel": {
696
+ "name": "logLevel",
697
+ "type": "option",
698
+ "char": "l",
699
+ "description": "The Log Level",
700
+ "required": false,
701
+ "multiple": false,
702
+ "options": [
703
+ "error",
704
+ "warn",
705
+ "info",
706
+ "debug"
707
+ ]
708
+ },
709
+ "alwaysConfirmEnv": {
710
+ "name": "alwaysConfirmEnv",
711
+ "type": "option",
712
+ "char": "e",
713
+ "description": "The Environment variables",
714
+ "required": false,
715
+ "multiple": false,
716
+ "options": [
717
+ "true",
718
+ "false"
719
+ ],
720
+ "default": "true"
721
+ },
722
+ "count": {
723
+ "name": "count",
724
+ "type": "option",
725
+ "char": "n",
726
+ "description": "Number of random entities to create",
727
+ "required": false,
728
+ "multiple": false
729
+ },
730
+ "dryRun": {
731
+ "name": "dryRun",
732
+ "type": "boolean",
733
+ "char": "d",
734
+ "description": "If true, does not create the entity but simulates the creation",
735
+ "required": false,
736
+ "allowNo": false
737
+ },
738
+ "inputFile": {
739
+ "name": "inputFile",
740
+ "type": "option",
741
+ "char": "i",
742
+ "description": "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.",
743
+ "required": false,
744
+ "multiple": false
745
+ },
746
+ "outputFile": {
747
+ "name": "outputFile",
748
+ "type": "option",
749
+ "char": "o",
750
+ "description": "File to save the output (optional)",
751
+ "required": false,
752
+ "multiple": false
753
+ },
754
+ "preciseProperties": {
755
+ "name": "preciseProperties",
756
+ "type": "boolean",
757
+ "char": "p",
758
+ "description": "If true, does not generate random values for properties. All values must be specified.",
759
+ "required": false,
760
+ "allowNo": false
761
+ },
762
+ "readableIds": {
763
+ "name": "readableIds",
764
+ "type": "boolean",
765
+ "char": "r",
766
+ "description": "If true, uses readable IDs for the created entities",
767
+ "required": false,
768
+ "allowNo": false
769
+ },
770
+ "skipHydrateRelationships": {
771
+ "name": "skipHydrateRelationships",
772
+ "type": "boolean",
773
+ "char": "s",
774
+ "description": "If true, does not hydrate relationships for the created entities",
775
+ "required": false,
776
+ "allowNo": false
777
+ }
778
+ },
779
+ "args": {
780
+ "path": {
781
+ "name": "path",
782
+ "description": "Path of the entity type to create",
783
+ "required": true
784
+ }
785
+ }
786
+ },
787
+ "entities:delete": {
788
+ "id": "entities:delete",
789
+ "description": "(BETA) Delete an entity",
790
+ "strict": true,
791
+ "pluginName": "@contrail/cli",
792
+ "pluginAlias": "@contrail/cli",
793
+ "pluginType": "core",
794
+ "aliases": [],
795
+ "examples": [
796
+ "contrail entities delete color 123"
797
+ ],
798
+ "flags": {
799
+ "logLevel": {
800
+ "name": "logLevel",
801
+ "type": "option",
802
+ "char": "l",
803
+ "description": "The Log Level",
804
+ "required": false,
805
+ "multiple": false,
806
+ "options": [
807
+ "error",
808
+ "warn",
809
+ "info",
810
+ "debug"
811
+ ]
812
+ },
813
+ "alwaysConfirmEnv": {
814
+ "name": "alwaysConfirmEnv",
815
+ "type": "option",
816
+ "char": "e",
817
+ "description": "The Environment variables",
818
+ "required": false,
819
+ "multiple": false,
820
+ "options": [
821
+ "true",
822
+ "false"
823
+ ],
824
+ "default": "true"
825
+ },
826
+ "dryRun": {
827
+ "name": "dryRun",
828
+ "type": "boolean",
829
+ "char": "d",
830
+ "description": "If true, does not delete the entity but simulates the deletion",
831
+ "required": false,
832
+ "allowNo": false
833
+ },
834
+ "input": {
835
+ "name": "input",
836
+ "type": "option",
837
+ "char": "i",
838
+ "description": "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.",
839
+ "required": false,
840
+ "multiple": false
841
+ },
842
+ "id": {
843
+ "name": "id",
844
+ "type": "option",
845
+ "description": "The unique identifier of the entity",
846
+ "required": false,
847
+ "multiple": false
848
+ }
849
+ },
850
+ "args": {
851
+ "entityName": {
852
+ "name": "entityName",
853
+ "description": "The name of the entity type to delete",
854
+ "required": true
855
+ }
856
+ }
857
+ },
858
+ "entities:get": {
859
+ "id": "entities:get",
860
+ "description": "(BETA) Get an entity",
861
+ "strict": false,
862
+ "pluginName": "@contrail/cli",
863
+ "pluginAlias": "@contrail/cli",
864
+ "pluginType": "core",
865
+ "aliases": [],
866
+ "examples": [
867
+ "contrail entities get color -- id=123",
868
+ "contrail entities get loader-processes -- createdOn=2025-09-15..2025-09-16",
869
+ "contrail entities get orders -- updatedAt=2025-09-15T04:00:00Z..",
870
+ "contrail entities get events -- timestamp=..2025-09-16T23:59:59Z"
871
+ ],
872
+ "flags": {
873
+ "logLevel": {
874
+ "name": "logLevel",
875
+ "type": "option",
876
+ "char": "l",
877
+ "description": "The Log Level",
878
+ "required": false,
879
+ "multiple": false,
880
+ "options": [
881
+ "error",
882
+ "warn",
883
+ "info",
884
+ "debug"
885
+ ]
886
+ },
887
+ "alwaysConfirmEnv": {
888
+ "name": "alwaysConfirmEnv",
889
+ "type": "option",
890
+ "char": "e",
891
+ "description": "The Environment variables",
892
+ "required": false,
893
+ "multiple": false,
894
+ "options": [
895
+ "true",
896
+ "false"
897
+ ],
898
+ "default": "true"
899
+ },
900
+ "outputFile": {
901
+ "name": "outputFile",
902
+ "type": "option",
903
+ "char": "o",
904
+ "description": "File to save the output (optional)",
905
+ "required": false,
906
+ "multiple": false
907
+ },
908
+ "skipHydrateRelationships": {
909
+ "name": "skipHydrateRelationships",
910
+ "type": "boolean",
911
+ "char": "s",
912
+ "description": "Skip hydrating relationships when fetching the entity",
913
+ "required": false,
914
+ "allowNo": false
915
+ },
916
+ "relations": {
917
+ "name": "relations",
918
+ "type": "option",
919
+ "char": "r",
920
+ "description": "Comma-separated list of relations to include in the output",
921
+ "required": false,
922
+ "multiple": false
923
+ },
924
+ "propertySlugs": {
925
+ "name": "propertySlugs",
926
+ "type": "option",
927
+ "char": "p",
928
+ "description": "Comma-separated list of property slugs to include in the output",
929
+ "required": false,
930
+ "multiple": false
931
+ },
932
+ "paginated": {
933
+ "name": "paginated",
934
+ "type": "boolean",
935
+ "char": "P",
936
+ "description": "If true, fetches all entities in a paginated manner",
937
+ "required": false,
938
+ "allowNo": false
939
+ },
940
+ "take": {
941
+ "name": "take",
942
+ "type": "option",
943
+ "char": "t",
944
+ "description": "Number of entities to fetch in a single request (default is 100)",
945
+ "required": false,
946
+ "multiple": false,
947
+ "default": 1000
948
+ }
949
+ },
950
+ "args": {
951
+ "typePath": {
952
+ "name": "typePath",
953
+ "description": "The name of the entity type to fetch",
954
+ "required": true
955
+ }
956
+ }
957
+ },
958
+ "entities:update": {
959
+ "id": "entities:update",
960
+ "description": "(BETA) Update an entity",
961
+ "strict": false,
962
+ "pluginName": "@contrail/cli",
963
+ "pluginAlias": "@contrail/cli",
964
+ "pluginType": "core",
965
+ "aliases": [],
966
+ "examples": [
967
+ "contrail entities update color 123 -- name=obsidian hex=000000"
968
+ ],
969
+ "flags": {
970
+ "logLevel": {
971
+ "name": "logLevel",
972
+ "type": "option",
973
+ "char": "l",
974
+ "description": "The Log Level",
975
+ "required": false,
976
+ "multiple": false,
977
+ "options": [
978
+ "error",
979
+ "warn",
980
+ "info",
981
+ "debug"
982
+ ]
983
+ },
984
+ "alwaysConfirmEnv": {
985
+ "name": "alwaysConfirmEnv",
986
+ "type": "option",
987
+ "char": "e",
988
+ "description": "The Environment variables",
989
+ "required": false,
990
+ "multiple": false,
991
+ "options": [
992
+ "true",
993
+ "false"
994
+ ],
995
+ "default": "true"
996
+ },
997
+ "skipHydrateRelationships": {
998
+ "name": "skipHydrateRelationships",
999
+ "type": "boolean",
1000
+ "char": "s",
1001
+ "description": "Skip hydrating relationships when updating the entity",
1002
+ "required": false,
1003
+ "allowNo": false
1004
+ },
1005
+ "dryRun": {
1006
+ "name": "dryRun",
1007
+ "type": "boolean",
1008
+ "char": "d",
1009
+ "description": "If true, does not create the entity but simulates the creation",
1010
+ "required": false,
1011
+ "allowNo": false
1012
+ },
1013
+ "inputFile": {
1014
+ "name": "inputFile",
1015
+ "type": "option",
1016
+ "char": "i",
1017
+ "description": "File containing properties to update the entity (optional)",
1018
+ "required": false,
1019
+ "multiple": false
1020
+ }
1021
+ },
1022
+ "args": {
1023
+ "entityName": {
1024
+ "name": "entityName",
1025
+ "description": "The name of the entity type to update",
1026
+ "required": true
1027
+ },
1028
+ "id": {
1029
+ "name": "id",
1030
+ "description": "The unique identifier of the entity",
1031
+ "required": true
1032
+ }
1033
+ }
1034
+ },
675
1035
  "file:upload": {
676
1036
  "id": "file:upload",
677
1037
  "description": "Uploads a file to the VibeIQ platform",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contrail/cli",
3
- "version": "3.3.3",
3
+ "version": "3.5.0-alpha",
4
4
  "description": "VibeIQ's Contrail Platform CLI.",
5
5
  "bin": {
6
6
  "contrail-cli": "./bin/run",
@@ -22,11 +22,11 @@
22
22
  "/oclif.manifest.json"
23
23
  ],
24
24
  "dependencies": {
25
- "@contrail/entity-types": "^1.3.0",
26
- "@contrail/org-config-migration": "^1.1.6",
27
- "@contrail/sdk": "^1.4.6",
25
+ "@contrail/entity-types": "^1.4.0-alpha",
26
+ "@contrail/org-config-migration": "^1.1.4",
27
+ "@contrail/sdk": "^1.6.0-alpha",
28
28
  "@contrail/types": "^3.0.48",
29
- "@contrail/util": "^1.1.10",
29
+ "@contrail/util": "^1.1.15",
30
30
  "@oclif/core": "^2",
31
31
  "@oclif/plugin-autocomplete": "^2.1.4",
32
32
  "@oclif/plugin-help": "^5",
@@ -49,6 +49,7 @@
49
49
  "ncp": "^2.0.0",
50
50
  "pkg-install": "^1.0.0",
51
51
  "semver": "^7.5.4",
52
+ "unique-names-generator": "^4.7.1",
52
53
  "winston": "^3.10.0",
53
54
  "zip-a-folder": "^1.1.5"
54
55
  },