@swell/cli 2.9.30 → 2.9.32
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.
- package/dist/commands/app/action.d.ts +25 -0
- package/dist/commands/app/action.js +233 -0
- package/dist/commands/app/delete.d.ts +33 -0
- package/dist/commands/app/delete.js +179 -0
- package/dist/commands/app/frontend/deploy.d.ts +1 -0
- package/dist/commands/app/frontend/deploy.js +4 -0
- package/dist/commands/app/push.d.ts +2 -0
- package/dist/commands/app/push.js +63 -2
- package/dist/commands/create/webhook.js +7 -13
- package/dist/commands/schema.js +5 -0
- package/dist/help/custom-help.js +5 -1
- package/dist/lib/apps/actions.d.ts +45 -0
- package/dist/lib/apps/actions.js +114 -0
- package/dist/lib/apps/listing.d.ts +1 -0
- package/dist/lib/apps/listing.js +41 -0
- package/dist/lib/bundle.js +11 -39
- package/dist/lib/function-declarations.d.ts +8 -0
- package/dist/lib/function-declarations.js +27 -0
- package/dist/lib/swell-function-wrapper.js +8 -1
- package/dist/lib/swell-workflow-request.d.ts +34 -0
- package/dist/lib/swell-workflow-request.js +58 -0
- package/dist/push-app-command.d.ts +2 -1
- package/dist/push-app-command.js +11 -3
- package/dist/remote-app-command.d.ts +1 -1
- package/dist/remote-app-command.js +1 -4
- package/oclif.manifest.json +178 -5
- package/package.json +2 -1
package/oclif.manifest.json
CHANGED
|
@@ -721,6 +721,179 @@
|
|
|
721
721
|
"_uninstall.js"
|
|
722
722
|
]
|
|
723
723
|
},
|
|
724
|
+
"app:action": {
|
|
725
|
+
"aliases": [],
|
|
726
|
+
"args": {
|
|
727
|
+
"id": {
|
|
728
|
+
"description": "id of the action, as declared in content or settings",
|
|
729
|
+
"name": "id",
|
|
730
|
+
"required": true
|
|
731
|
+
}
|
|
732
|
+
},
|
|
733
|
+
"description": "Runs a function action of the app as the logged-in dashboard user, the way a click in the dashboard does. The action is looked up in the app's content and settings as pushed.\n\nA record action or action field needs --record, and a bulk action --ids or --all. Pass the values of the action's modal with --values. When the same id is declared in more than one place, pick one with --collection, --view, --settings or --source.",
|
|
734
|
+
"examples": [
|
|
735
|
+
"swell app action sync_now",
|
|
736
|
+
"swell app action ship --record 64e8dfb633c44a0039477251",
|
|
737
|
+
"swell app action ship --record 64e8dfb633c44a0039477251 --values '{\"carrier\":\"ups\"}'",
|
|
738
|
+
"swell app action ship-selected --ids 64e8dfb633c44a0039477251,64e8dfb633c44a0039477252",
|
|
739
|
+
"swell app action ship --collection shipments --view edit --record 64e8dfb633c44a0039477251",
|
|
740
|
+
"swell app action export --source bulk --all"
|
|
741
|
+
],
|
|
742
|
+
"flags": {
|
|
743
|
+
"app-path": {
|
|
744
|
+
"description": "Path to your app directory",
|
|
745
|
+
"name": "app-path",
|
|
746
|
+
"hasDynamicHelp": false,
|
|
747
|
+
"multiple": false,
|
|
748
|
+
"type": "option"
|
|
749
|
+
},
|
|
750
|
+
"all": {
|
|
751
|
+
"description": "run a bulk action on all records its view lists with no filters set, as selecting all in the dashboard does",
|
|
752
|
+
"exclusive": [
|
|
753
|
+
"ids"
|
|
754
|
+
],
|
|
755
|
+
"name": "all",
|
|
756
|
+
"allowNo": false,
|
|
757
|
+
"type": "boolean"
|
|
758
|
+
},
|
|
759
|
+
"collection": {
|
|
760
|
+
"description": "collection of the content that declares the action, or the model's name for a collection of the app",
|
|
761
|
+
"name": "collection",
|
|
762
|
+
"hasDynamicHelp": false,
|
|
763
|
+
"multiple": false,
|
|
764
|
+
"type": "option"
|
|
765
|
+
},
|
|
766
|
+
"ids": {
|
|
767
|
+
"description": "comma-separated ids of the records a bulk action runs on",
|
|
768
|
+
"exclusive": [
|
|
769
|
+
"all"
|
|
770
|
+
],
|
|
771
|
+
"name": "ids",
|
|
772
|
+
"hasDynamicHelp": false,
|
|
773
|
+
"multiple": false,
|
|
774
|
+
"type": "option"
|
|
775
|
+
},
|
|
776
|
+
"live": {
|
|
777
|
+
"description": "run in the live environment instead of test",
|
|
778
|
+
"name": "live",
|
|
779
|
+
"allowNo": false,
|
|
780
|
+
"type": "boolean"
|
|
781
|
+
},
|
|
782
|
+
"record": {
|
|
783
|
+
"description": "id of the record a record action or action field runs on",
|
|
784
|
+
"name": "record",
|
|
785
|
+
"hasDynamicHelp": false,
|
|
786
|
+
"multiple": false,
|
|
787
|
+
"type": "option"
|
|
788
|
+
},
|
|
789
|
+
"settings": {
|
|
790
|
+
"description": "name of the settings that declare the action",
|
|
791
|
+
"name": "settings",
|
|
792
|
+
"hasDynamicHelp": false,
|
|
793
|
+
"multiple": false,
|
|
794
|
+
"type": "option"
|
|
795
|
+
},
|
|
796
|
+
"source": {
|
|
797
|
+
"description": "where the action is declared: list or record (a view's actions), bulk (a view's bulk actions), field (an action field) or settings (a settings action)",
|
|
798
|
+
"name": "source",
|
|
799
|
+
"hasDynamicHelp": false,
|
|
800
|
+
"multiple": false,
|
|
801
|
+
"options": [
|
|
802
|
+
"list",
|
|
803
|
+
"record",
|
|
804
|
+
"bulk",
|
|
805
|
+
"field",
|
|
806
|
+
"settings"
|
|
807
|
+
],
|
|
808
|
+
"type": "option"
|
|
809
|
+
},
|
|
810
|
+
"values": {
|
|
811
|
+
"description": "values of the action's modal fields, as JSON",
|
|
812
|
+
"name": "values",
|
|
813
|
+
"hasDynamicHelp": false,
|
|
814
|
+
"multiple": false,
|
|
815
|
+
"type": "option"
|
|
816
|
+
},
|
|
817
|
+
"view": {
|
|
818
|
+
"description": "id of the content view that declares the action",
|
|
819
|
+
"name": "view",
|
|
820
|
+
"hasDynamicHelp": false,
|
|
821
|
+
"multiple": false,
|
|
822
|
+
"type": "option"
|
|
823
|
+
}
|
|
824
|
+
},
|
|
825
|
+
"hasDynamicHelp": false,
|
|
826
|
+
"hiddenAliases": [],
|
|
827
|
+
"id": "app:action",
|
|
828
|
+
"pluginAlias": "@swell/cli",
|
|
829
|
+
"pluginName": "@swell/cli",
|
|
830
|
+
"pluginType": "core",
|
|
831
|
+
"strict": true,
|
|
832
|
+
"summary": "Run an app action from the command line.",
|
|
833
|
+
"enableJsonFlag": false,
|
|
834
|
+
"requiresSwellConfig": true,
|
|
835
|
+
"delayOrientation": false,
|
|
836
|
+
"isESM": true,
|
|
837
|
+
"relativePath": [
|
|
838
|
+
"dist",
|
|
839
|
+
"commands",
|
|
840
|
+
"app",
|
|
841
|
+
"action.js"
|
|
842
|
+
]
|
|
843
|
+
},
|
|
844
|
+
"app:delete": {
|
|
845
|
+
"aliases": [],
|
|
846
|
+
"args": {},
|
|
847
|
+
"description": "Deletes the app from the store that owns it, to free a slot under the store's app limit.\n\nThe app's versions, configs, functions and its development install in the test environment are removed. Records the app created in the store are not deleted.\n\nAn app can't be deleted while it is installed anywhere else, if it is linked to a partner, or if it was ever published. The command lists what blocks it.\n\nAfter deleting, .swellrc is removed, so the next `swell app push` creates a new app.",
|
|
848
|
+
"examples": [
|
|
849
|
+
"swell app delete",
|
|
850
|
+
"swell app delete --confirm",
|
|
851
|
+
"swell app delete --confirm -y"
|
|
852
|
+
],
|
|
853
|
+
"flags": {
|
|
854
|
+
"app-path": {
|
|
855
|
+
"description": "Path to your app directory",
|
|
856
|
+
"name": "app-path",
|
|
857
|
+
"hasDynamicHelp": false,
|
|
858
|
+
"multiple": false,
|
|
859
|
+
"type": "option"
|
|
860
|
+
},
|
|
861
|
+
"confirm": {
|
|
862
|
+
"description": "confirm deleting the app, instead of being asked",
|
|
863
|
+
"name": "confirm",
|
|
864
|
+
"allowNo": false,
|
|
865
|
+
"type": "boolean"
|
|
866
|
+
},
|
|
867
|
+
"yes": {
|
|
868
|
+
"char": "y",
|
|
869
|
+
"description": "skip all prompts; requires --confirm",
|
|
870
|
+
"name": "yes",
|
|
871
|
+
"allowNo": false,
|
|
872
|
+
"type": "boolean"
|
|
873
|
+
}
|
|
874
|
+
},
|
|
875
|
+
"hasDynamicHelp": false,
|
|
876
|
+
"hiddenAliases": [],
|
|
877
|
+
"id": "app:delete",
|
|
878
|
+
"pluginAlias": "@swell/cli",
|
|
879
|
+
"pluginName": "@swell/cli",
|
|
880
|
+
"pluginType": "core",
|
|
881
|
+
"strict": true,
|
|
882
|
+
"summary": "Delete an app your store owns.",
|
|
883
|
+
"enableJsonFlag": false,
|
|
884
|
+
"requiresSwellConfig": true,
|
|
885
|
+
"delayOrientation": false,
|
|
886
|
+
"orientation": {
|
|
887
|
+
"env": "test"
|
|
888
|
+
},
|
|
889
|
+
"isESM": true,
|
|
890
|
+
"relativePath": [
|
|
891
|
+
"dist",
|
|
892
|
+
"commands",
|
|
893
|
+
"app",
|
|
894
|
+
"delete.js"
|
|
895
|
+
]
|
|
896
|
+
},
|
|
724
897
|
"app:dev": {
|
|
725
898
|
"aliases": [],
|
|
726
899
|
"args": {},
|
|
@@ -1184,7 +1357,7 @@
|
|
|
1184
1357
|
"name": "file"
|
|
1185
1358
|
}
|
|
1186
1359
|
},
|
|
1187
|
-
"description": "Push all app files, a specific file, or a specific configuration\ntype to an app in your store's test environment.\n\nIf the app does not exist, it will be created and its global ID saved to a .swellrc file.\n\n- If no file is specified, all configuration files will be pushed to the store.\n This includes the app icon (assets/icon.png), screenshots (assets/screenshots/),\n
|
|
1360
|
+
"description": "Push all app files, a specific file, or a specific configuration\ntype to an app in your store's test environment.\n\nIf the app does not exist, it will be created and its global ID saved to a .swellrc file.\n\n- If no file is specified, all configuration files will be pushed to the store.\n This includes the app icon (assets/icon.png), screenshots (assets/screenshots/),\n DESCRIPTION.md, and swell.json.\n- If a file is specified, only that file will be pushed to the store.\n- If a directory is specified, only files in that directory will be pushed.\n\nPushing anything under frontend/ also builds and deploys the app frontend, so\nthe deployed frontend matches what was pushed. Use --no-deploy to skip it.\n\nApp file directories:\nassets/\ncontent/\nfrontend/\ncomponents/\nfunctions/\nmodels/\nnotifications/\nsettings/\ntheme/\nwebhooks/",
|
|
1188
1361
|
"examples": [
|
|
1189
1362
|
"swell app push",
|
|
1190
1363
|
"swell app push content",
|
|
@@ -2422,7 +2595,7 @@
|
|
|
2422
2595
|
"examples": [
|
|
2423
2596
|
"$ swell create webhook",
|
|
2424
2597
|
"$ swell create webhook order-sync -u https://example.com/hook -e order.created -y",
|
|
2425
|
-
"$ swell create webhook payment-handler -u https://api.example.com/payments -e payment.succeeded,payment.failed --enabled -y"
|
|
2598
|
+
"$ swell create webhook payment-handler -u https://api.example.com/payments -e payment.succeeded,payment.failed --no-enabled -y"
|
|
2426
2599
|
],
|
|
2427
2600
|
"flags": {
|
|
2428
2601
|
"app-path": {
|
|
@@ -2460,9 +2633,9 @@
|
|
|
2460
2633
|
"type": "option"
|
|
2461
2634
|
},
|
|
2462
2635
|
"enabled": {
|
|
2463
|
-
"description": "Enable webhook (default:
|
|
2636
|
+
"description": "Enable webhook (default: true)",
|
|
2464
2637
|
"name": "enabled",
|
|
2465
|
-
"allowNo":
|
|
2638
|
+
"allowNo": true,
|
|
2466
2639
|
"type": "boolean"
|
|
2467
2640
|
},
|
|
2468
2641
|
"overwrite": {
|
|
@@ -3685,5 +3858,5 @@
|
|
|
3685
3858
|
]
|
|
3686
3859
|
}
|
|
3687
3860
|
},
|
|
3688
|
-
"version": "2.9.
|
|
3861
|
+
"version": "2.9.32"
|
|
3689
3862
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@swell/cli",
|
|
3
|
-
"version": "2.9.
|
|
3
|
+
"version": "2.9.32",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Swell's command line interface/utility",
|
|
6
6
|
"keywords": [
|
|
@@ -30,6 +30,7 @@
|
|
|
30
30
|
"@npmcli/git": "5.0.3",
|
|
31
31
|
"@oclif/core": "3.7.1",
|
|
32
32
|
"@oclif/plugin-help": "6.0.4",
|
|
33
|
+
"@swell/app-types": "1.3.0",
|
|
33
34
|
"ajv": "8.20.0",
|
|
34
35
|
"ajv-errors": "3.0.0",
|
|
35
36
|
"ajv-formats": "3.0.1",
|