Add support for Workflow and User Interaction Custom Forms `pull` operation in Typescript based projects

[VenelinBakalov]

Description

Typescript projects currently support push of Workflow Custom Forms and with #817 we will introduce push of User Interaction Custom Forms. However, there is no easy way to extract those forms in a readable JSON format on the file system. Thus we are discussing internally the viability of adding a limited pull operation for Typescript projects which will be limited to extracting those forms.

Alternatives

1. Once a custom form from is created the Orchestrator UI, in the Workflow edit page navigate to Version history.
2. From that menu the Workflow form YAML can be extracted and converted to JSON with the help of a YAML to JSON converter.
3. In the converted JSON a nested element can be extracted that corresponds to the User Interaction Custom Form. Only the entry from the inputForms array is needed, the metadata outside is already auto generated during Typescript transpilation.

Additional Context

Blocked by #817

[VenelinBakalov]

Currently under internal discussion! Might not get accepted, however I still want to have this tracked and to put here research on the topic.

[VenelinBakalov]

A possible approach:

1. Read all files under project root -> src and find the ones that have .wf.ts extension
2. Extract the ID (if present) or path + name values from the @Workflow decorator
3. If the ID is not present, use path + name to find the Workflow via REST and get it's ID
4. Use Workflow ID to extract all Custom Forms related to the workflow
5. Write the forms to file

API calls:

1. Get Workflow: /vco/api/workflows/{workflowId}
2. Get all Custom Froms for given Workflow: /vco/api/forms?conditions=workflow={workflowId}

Note that the Workflow Custom Form is the first entry and it has empty string for "itemId".
Sample output:

[
    {
        "layout": {
            "pages": [
                {
                    "id": "page_bf383f33",
                    "sections": [
                        {
                            "id": "section_9fdde853",
                            "fields": [
                                {
                                    "id": "textArea_f90e469e",
                                    "display": "textArea",
                                    "state": {
                                        "visible": true,
                                        "read-only": false
                                    },
                                    "signpostPosition": "right-middle"
                                }
                            ]
                        }
                    ],
                    "title": "New tab",
                    "state": {}
                }
            ]
        },
        "schema": {
            "textArea_f90e469e": {
                "label": "111111",
                "placeholder": "",
                "type": {
                    "dataType": "string"
                },
                "constraints": {}
            }
        },
        "options": {
            "externalValidations": []
        },
        "itemId": ""
    },
    {
        "layout": {
            "pages": [
                {
                    "id": "page_0504604e",
                    "sections": [
                        {
                            "id": "section_f546f863",
                            "fields": [
                                {
                                    "id": "textArea_2d20ebf3",
                                    "display": "textArea",
                                    "state": {
                                        "visible": true,
                                        "read-only": false
                                    },
                                    "signpostPosition": "right-middle"
                                }
                            ]
                        }
                    ],
                    "title": "New tab",
                    "state": {}
                }
            ]
        },
        "schema": {
            "textArea_2d20ebf3": {
                "label": "2222",
                "placeholder": "",
                "type": {
                    "dataType": "string"
                },
                "constraints": {}
            }
        },
        "options": {
            "externalValidations": []
        },
        "itemId": "item1"
    },
    {
        "layout": {
            "pages": [
                {
                    "id": "page_18b5cb6f",
                    "sections": [
                        {
                            "id": "section_c25ad532",
                            "fields": [
                                {
                                    "id": "text_db1930e7",
                                    "display": "text",
                                    "state": {
                                        "visible": true,
                                        "read-only": false
                                    },
                                    "signpostPosition": "right-middle"
                                }
                            ]
                        }
                    ],
                    "title": "form 2 tab 1",
                    "state": {}
                },
                {
                    "id": "page_716330ca",
                    "sections": [
                        {
                            "id": "section_77d688ec",
                            "fields": [
                                {
                                    "id": "textArea_e5c218dd",
                                    "display": "textArea",
                                    "state": {
                                        "visible": true,
                                        "read-only": false
                                    },
                                    "signpostPosition": "right-middle"
                                }
                            ]
                        }
                    ],
                    "title": "form 2 tab 2",
                    "state": {}
                }
            ]
        },
        "schema": {
            "text_db1930e7": {
                "type": {
                    "dataType": "string"
                },
                "constraints": {},
                "default": "44444444"
            },
            "textArea_e5c218dd": {
                "label": "Text Area",
                "placeholder": "",
                "type": {
                    "dataType": "string"
                },
                "constraints": {},
                "default": "5555555555"
            }
        },
        "options": {
            "externalValidations": []
        },
        "itemId": "item2"
    }
]

Issues:
There might not be easy way to extract a Workflow via path + name

[VenelinBakalov]

Possible approach to extract workflow via path:
Get All Workflows: /vco/api/workflows

In the response it seems the tags (parts of the path) are available as a single string separated by :SYSTEM_TAG

                {
                    "value": "PSCoE:__SYSTEM_TAG__ my-project:__SYSTEM_TAG__ integration-service-1:__SYSTEM_TAG__ workflows:__SYSTEM_TAG__",
                    "name": "globalTags"
                }

Which corresponds to:

{
            "attributes": [
                {
                    "value": "https://vcfa.corp.internal:443/vco/api/workflows/b5b9515f-6a7f-34d7-a544-3d0220c576fa/",
                    "name": "itemHref"
                },
                {
                    "value": "true",
                    "name": "canExecute"
                },
                {
                    "value": "true",
                    "name": "editable"
                },
                {
                    "value": "Workflow",
                    "name": "@type"
                },
                {
                    "value": "true",
                    "name": "canEdit"
                },
                {
                    "value": "Sample workflow description",
                    "name": "description"
                },
                {
                    "value": "https://vcfa.corp.internal:443/vco/api/catalog/System/WorkflowCategory/708080e5986551770198844d65c62d4b/",
                    "name": "categoryHref"
                },
                {
                    "value": "Workflow",
                    "name": "type"
                },
                {
                    "value": "PSCoE:__SYSTEM_TAG__ my-project:__SYSTEM_TAG__ integration-service-1:__SYSTEM_TAG__ workflows:__SYSTEM_TAG__",
                    "name": "globalTags"
                },
                {
                    "value": "1.0.0",
                    "name": "version"
                },
                {
                    "value": "workflows",
                    "name": "categoryName"
                },
                {
                    "value": "1754566321631",
                    "name": "createdAt"
                },
                {
                    "value": "Create Integration",
                    "name": "@name"
                },
                {
                    "value": "Create Integration",
                    "name": "name"
                },
                {
                    "value": "b5b9515f-6a7f-34d7-a544-3d0220c576fa",
                    "name": "id"
                },
                {
                    "value": "Workflow",
                    "name": "@fullType"
                },
                {
                    "value": "b5b9515f-6a7f-34d7-a544-3d0220c576fa",
                    "name": "@id"
                },
                {
                    "value": "708080e5986551770198844d65c62d4b",
                    "name": "categoryId"
                },
                {
                    "value": "false",
                    "name": "customIcon"
                },
                {
                    "value": "1754566321631",
                    "name": "updatedAt"
                }
            ],
            "href": "https://vcfa.corp.internal:443/vco/api/workflows/b5b9515f-6a7f-34d7-a544-3d0220c576fa/",
            "rel": "down"
        }

[VenelinBakalov]

@Indy-rbo FYI