@docyrus/docyrus 0.0.80 → 0.1.0
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/main.js +1169 -171
- package/main.js.map +3 -3
- package/package.json +1 -1
- package/resources/pi-agent/skills/docyrus-platform/references/docyrus-cli-usage.md +242 -1
package/package.json
CHANGED
|
@@ -467,7 +467,7 @@ Permanently delete an app.
|
|
|
467
467
|
|
|
468
468
|
## studio — Schema Management
|
|
469
469
|
|
|
470
|
-
Manage data source schemas, fields, and
|
|
470
|
+
Manage data source schemas, fields, enumerations, saved views, forms, public webforms, HTML/PDF/DOCX export templates, and email templates via the development API.
|
|
471
471
|
|
|
472
472
|
**Common selector rules:**
|
|
473
473
|
- App: exactly one of `--appId` or `--appSlug`
|
|
@@ -628,6 +628,247 @@ Same options as `create-enums` (without `--enumSetId`).
|
|
|
628
628
|
|
|
629
629
|
Same options. Payload key: `enumIds`.
|
|
630
630
|
|
|
631
|
+
### Data View Commands
|
|
632
|
+
|
|
633
|
+
Saved view definitions for a data source. Routes through `/v1/apps/:appSlug/data-sources/:dataSourceSlug/views`. App and data source can be supplied as id or slug — the CLI resolves whichever side is missing.
|
|
634
|
+
|
|
635
|
+
#### `docyrus studio list-data-views`
|
|
636
|
+
|
|
637
|
+
| Option | Type | Description |
|
|
638
|
+
|---|---|---|
|
|
639
|
+
| `--appId / --appSlug` | string | App selector |
|
|
640
|
+
| `--dataSourceId / --dataSourceSlug` | string | Data source selector |
|
|
641
|
+
| `--tenantAppId` | string | Optional tenant app ID to scope the view list |
|
|
642
|
+
|
|
643
|
+
#### `docyrus studio get-data-view`
|
|
644
|
+
|
|
645
|
+
Same selectors as `list-data-views`, plus `--viewId` (required).
|
|
646
|
+
|
|
647
|
+
#### `docyrus studio create-data-view`
|
|
648
|
+
|
|
649
|
+
| Option | Type | Description |
|
|
650
|
+
|---|---|---|
|
|
651
|
+
| `--appId / --appSlug` | string | App selector |
|
|
652
|
+
| `--dataSourceId / --dataSourceSlug` | string | Data source selector |
|
|
653
|
+
| `--data` | string | JSON payload |
|
|
654
|
+
| `--fromFile` | string | Path to JSON file |
|
|
655
|
+
| `--name` | string | View name |
|
|
656
|
+
| `--description` | string | View description |
|
|
657
|
+
| `--tenantAppId` | string | Optional tenant app ID |
|
|
658
|
+
| `--columns` | string | JSON columns payload |
|
|
659
|
+
| `--filters` | string | JSON filters payload |
|
|
660
|
+
| `--sort` | string | JSON sort payload |
|
|
661
|
+
| `--color` | string | Color |
|
|
662
|
+
| `--icon` | string | Icon |
|
|
663
|
+
| `--colorRules` | string | JSON color rules payload |
|
|
664
|
+
| `--quickFilterFields` | string | JSON array of field slugs |
|
|
665
|
+
| `--isDefault` | boolean | Mark as default view |
|
|
666
|
+
| `--sortOrder` | number | Sort order |
|
|
667
|
+
|
|
668
|
+
#### `docyrus studio update-data-view`
|
|
669
|
+
|
|
670
|
+
Same options as `create-data-view`, plus `--viewId` (required) and `--archived` (boolean).
|
|
671
|
+
|
|
672
|
+
#### `docyrus studio delete-data-view`
|
|
673
|
+
|
|
674
|
+
Same selectors as `list-data-views`, plus `--viewId` (required).
|
|
675
|
+
|
|
676
|
+
### Form Commands
|
|
677
|
+
|
|
678
|
+
Data source form definitions used by record-entry UIs. Routes through `/v1/apps/:appSlug/data-sources/:dataSourceSlug/forms`.
|
|
679
|
+
|
|
680
|
+
#### `docyrus studio list-forms`
|
|
681
|
+
|
|
682
|
+
| Option | Type | Description |
|
|
683
|
+
|---|---|---|
|
|
684
|
+
| `--appId / --appSlug` | string | App selector |
|
|
685
|
+
| `--dataSourceId / --dataSourceSlug` | string | Data source selector |
|
|
686
|
+
|
|
687
|
+
#### `docyrus studio get-form`
|
|
688
|
+
|
|
689
|
+
Same selectors as `list-forms`, plus `--formId` (required).
|
|
690
|
+
|
|
691
|
+
#### `docyrus studio create-form`
|
|
692
|
+
|
|
693
|
+
| Option | Type | Description |
|
|
694
|
+
|---|---|---|
|
|
695
|
+
| `--appId / --appSlug` | string | App selector |
|
|
696
|
+
| `--dataSourceId / --dataSourceSlug` | string | Data source selector |
|
|
697
|
+
| `--data` | string | JSON payload |
|
|
698
|
+
| `--fromFile` | string | Path to JSON file |
|
|
699
|
+
| `--name` | string | Form name |
|
|
700
|
+
| `--description` | string | Description |
|
|
701
|
+
| `--title` | string | Title |
|
|
702
|
+
| `--subtopic` | string | Subtopic |
|
|
703
|
+
| `--color` | string | Color |
|
|
704
|
+
| `--icon` | string | Icon |
|
|
705
|
+
| `--layout` | string | JSON layout payload |
|
|
706
|
+
| `--isDefault` | boolean | Mark as default form |
|
|
707
|
+
| `--status` | number | Form status |
|
|
708
|
+
|
|
709
|
+
#### `docyrus studio update-form`
|
|
710
|
+
|
|
711
|
+
Same options as `create-form`, plus `--formId` (required) and `--archived` (boolean).
|
|
712
|
+
|
|
713
|
+
#### `docyrus studio delete-form`
|
|
714
|
+
|
|
715
|
+
Same selectors as `list-forms`, plus `--formId` (required).
|
|
716
|
+
|
|
717
|
+
### Webform Commands
|
|
718
|
+
|
|
719
|
+
Public-facing webforms. Routes through `/v1/dev/webforms`. CRUD by `--webformId`. List and create accept either `--dataSourceId` or `--dataSourceSlug` (slug requires `--appId` or `--appSlug` to resolve).
|
|
720
|
+
|
|
721
|
+
#### `docyrus studio list-webforms`
|
|
722
|
+
|
|
723
|
+
| Option | Type | Description |
|
|
724
|
+
|---|---|---|
|
|
725
|
+
| `--appId / --appSlug` | string | Optional, used to resolve `--dataSourceSlug` |
|
|
726
|
+
| `--dataSourceId` | string | Filter by data source ID |
|
|
727
|
+
| `--dataSourceSlug` | string | Filter by data source slug (requires `--appId` or `--appSlug`) |
|
|
728
|
+
|
|
729
|
+
#### `docyrus studio get-webform`
|
|
730
|
+
|
|
731
|
+
| Option | Type | Description |
|
|
732
|
+
|---|---|---|
|
|
733
|
+
| `--webformId` | string | Webform ID (required) |
|
|
734
|
+
|
|
735
|
+
#### `docyrus studio create-webform`
|
|
736
|
+
|
|
737
|
+
| Option | Type | Description |
|
|
738
|
+
|---|---|---|
|
|
739
|
+
| `--appId / --appSlug` | string | Optional, used to resolve `--dataSourceSlug` |
|
|
740
|
+
| `--dataSourceId` | string | Data source ID to bind the webform to |
|
|
741
|
+
| `--dataSourceSlug` | string | Data source slug (requires `--appId` or `--appSlug`) |
|
|
742
|
+
| `--data` | string | JSON payload |
|
|
743
|
+
| `--fromFile` | string | Path to JSON file |
|
|
744
|
+
| `--name` | string | Webform name |
|
|
745
|
+
| `--schema` | string | JSON schema payload |
|
|
746
|
+
| `--status` | number | Status (1 active, 2 inactive) |
|
|
747
|
+
| `--webformOptions` | string | JSON options payload |
|
|
748
|
+
| `--sandbox` | boolean | Sandbox flag |
|
|
749
|
+
| `--css` | string | Custom CSS |
|
|
750
|
+
|
|
751
|
+
When `dataSourceId` is omitted, submissions land in the tenant-schema `webform_record` table instead of a data source.
|
|
752
|
+
|
|
753
|
+
#### `docyrus studio update-webform`
|
|
754
|
+
|
|
755
|
+
| Option | Type | Description |
|
|
756
|
+
|---|---|---|
|
|
757
|
+
| `--webformId` | string | Webform ID (required) |
|
|
758
|
+
| `--data` | string | JSON payload |
|
|
759
|
+
| `--fromFile` | string | Path to JSON file |
|
|
760
|
+
| `--name` | string | Webform name |
|
|
761
|
+
| `--schema` | string | JSON schema payload |
|
|
762
|
+
| `--status` | number | Status (1 active, 2 inactive) |
|
|
763
|
+
| `--webformOptions` | string | JSON options payload |
|
|
764
|
+
| `--sandbox` | boolean | Sandbox flag |
|
|
765
|
+
| `--css` | string | Custom CSS |
|
|
766
|
+
|
|
767
|
+
#### `docyrus studio delete-webform`
|
|
768
|
+
|
|
769
|
+
| Option | Type | Description |
|
|
770
|
+
|---|---|---|
|
|
771
|
+
| `--webformId` | string | Webform ID (required) |
|
|
772
|
+
|
|
773
|
+
### HTML Template Commands
|
|
774
|
+
|
|
775
|
+
HTML/PDF/DOCX export templates. Routes through `/v1/dev/html-templates`. CRUD by `--templateId`. Data source binding is required on create; slug requires `--appId` or `--appSlug`.
|
|
776
|
+
|
|
777
|
+
#### `docyrus studio list-html-templates`
|
|
778
|
+
|
|
779
|
+
| Option | Type | Description |
|
|
780
|
+
|---|---|---|
|
|
781
|
+
| `--appId / --appSlug` | string | Optional, used to resolve `--dataSourceSlug` |
|
|
782
|
+
| `--dataSourceId` | string | Filter by data source ID |
|
|
783
|
+
| `--dataSourceSlug` | string | Filter by data source slug (requires `--appId` or `--appSlug`) |
|
|
784
|
+
| `--isDefault` | boolean | Filter by default flag |
|
|
785
|
+
| `--limit` | number | Page size (default 100) |
|
|
786
|
+
| `--offset` | number | Page offset (default 0) |
|
|
787
|
+
|
|
788
|
+
#### `docyrus studio get-html-template`
|
|
789
|
+
|
|
790
|
+
| Option | Type | Description |
|
|
791
|
+
|---|---|---|
|
|
792
|
+
| `--templateId` | string | HTML template ID (required) |
|
|
793
|
+
|
|
794
|
+
#### `docyrus studio create-html-template`
|
|
795
|
+
|
|
796
|
+
| Option | Type | Description |
|
|
797
|
+
|---|---|---|
|
|
798
|
+
| `--appId / --appSlug` | string | Optional, used to resolve `--dataSourceSlug` |
|
|
799
|
+
| `--dataSourceId` | string | Data source ID this template binds to |
|
|
800
|
+
| `--dataSourceSlug` | string | Data source slug (requires `--appId` or `--appSlug`) |
|
|
801
|
+
| `--data` | string | JSON payload |
|
|
802
|
+
| `--fromFile` | string | Path to JSON file |
|
|
803
|
+
| `--name` | string | Template name |
|
|
804
|
+
| `--filenameTmpl` | string | Filename template |
|
|
805
|
+
| `--pageOrientation` | string | Page orientation |
|
|
806
|
+
| `--sourceType` | string | Source type (`html`, `pdf`, `docx`, ...) |
|
|
807
|
+
| `--marginLeft` | number | Left margin |
|
|
808
|
+
| `--marginRight` | number | Right margin |
|
|
809
|
+
| `--marginTop` | number | Top margin |
|
|
810
|
+
| `--marginBottom` | number | Bottom margin |
|
|
811
|
+
| `--pageFormat` | string | Page format (`A4`, `Letter`, ...) |
|
|
812
|
+
| `--body` | string | HTML body |
|
|
813
|
+
| `--isDefault` | boolean | Mark as default template |
|
|
814
|
+
| `--headerTmpl` | string | Header template |
|
|
815
|
+
| `--footerTmpl` | string | Footer template |
|
|
816
|
+
| `--styles` | string | Inline CSS styles |
|
|
817
|
+
|
|
818
|
+
#### `docyrus studio update-html-template`
|
|
819
|
+
|
|
820
|
+
Same options as `create-html-template`, plus `--templateId` (required).
|
|
821
|
+
|
|
822
|
+
#### `docyrus studio delete-html-template`
|
|
823
|
+
|
|
824
|
+
| Option | Type | Description |
|
|
825
|
+
|---|---|---|
|
|
826
|
+
| `--templateId` | string | HTML template ID (required) |
|
|
827
|
+
|
|
828
|
+
### Email Template Commands
|
|
829
|
+
|
|
830
|
+
Transactional email templates. Routes through `/v1/dev/email-templates`. CRUD by `--templateId`. Data source binding is optional.
|
|
831
|
+
|
|
832
|
+
#### `docyrus studio list-email-templates`
|
|
833
|
+
|
|
834
|
+
| Option | Type | Description |
|
|
835
|
+
|---|---|---|
|
|
836
|
+
| `--appId / --appSlug` | string | Optional, used to resolve `--dataSourceSlug` |
|
|
837
|
+
| `--dataSourceId` | string | Filter by data source ID |
|
|
838
|
+
| `--dataSourceSlug` | string | Filter by data source slug (requires `--appId` or `--appSlug`) |
|
|
839
|
+
| `--limit` | number | Page size (default 100) |
|
|
840
|
+
| `--offset` | number | Page offset (default 0) |
|
|
841
|
+
|
|
842
|
+
#### `docyrus studio get-email-template`
|
|
843
|
+
|
|
844
|
+
| Option | Type | Description |
|
|
845
|
+
|---|---|---|
|
|
846
|
+
| `--templateId` | string | Email template ID (required) |
|
|
847
|
+
|
|
848
|
+
#### `docyrus studio create-email-template`
|
|
849
|
+
|
|
850
|
+
| Option | Type | Description |
|
|
851
|
+
|---|---|---|
|
|
852
|
+
| `--appId / --appSlug` | string | Optional, used to resolve `--dataSourceSlug` |
|
|
853
|
+
| `--dataSourceId` | string | Optional data source ID to bind the template to |
|
|
854
|
+
| `--dataSourceSlug` | string | Data source slug (requires `--appId` or `--appSlug`) |
|
|
855
|
+
| `--data` | string | JSON payload |
|
|
856
|
+
| `--fromFile` | string | Path to JSON file |
|
|
857
|
+
| `--name` | string | Template name |
|
|
858
|
+
| `--subject` | string | Email subject |
|
|
859
|
+
| `--body` | string | Email body |
|
|
860
|
+
| `--ownership` | string | Ownership (`system`, `user`, ...) |
|
|
861
|
+
|
|
862
|
+
#### `docyrus studio update-email-template`
|
|
863
|
+
|
|
864
|
+
Same options as `create-email-template`, plus `--templateId` (required).
|
|
865
|
+
|
|
866
|
+
#### `docyrus studio delete-email-template`
|
|
867
|
+
|
|
868
|
+
| Option | Type | Description |
|
|
869
|
+
|---|---|---|
|
|
870
|
+
| `--templateId` | string | Email template ID (required) |
|
|
871
|
+
|
|
631
872
|
---
|
|
632
873
|
|
|
633
874
|
## curl — Direct API Requests
|