feat(utils): Wsdl to TS typings

[jeclrsg]

Checklist:

• The commit message is properly formatted and free of typos.
  • The commit message title makes sense in a changelog, by itself.
  • The commit message includes a "fixes" reference if appropriate.
  • The commit is signed.
• [] The change has been fully tested:
  • I have viewed all related gallery items
  • I have viewed all related dermatology items
• There are no similar instances of the same problem that should be addressed
  • I have addressed them here
  • I have raised new issues to address them separately

Testing:

[GordonSmith]

A potential (and correct) output for "WUQueryActivationMode" could be:

export enum WUQueryActivationMode {
    Do_not_activate_query = 0,
    Activate_query = 1,
    Activate_query__suspend_previous = 2,
    Activate_query__delete_previous = 3
}

Note: WsDFU has a few more of these...

[GordonSmith]

Next you could generate the calling stub for each operation:

<operation name="WUAction">
<soap:operation soapAction="WsWorkunits/WUAction?ver_=1.85" style="document"/>
<input>
<soap:body use="literal"/>
</input>
<output>
<soap:body use="literal"/>
</output>
<fault name="excfault">
<soap:fault name="excfault" use="literal"/>
</fault>
</operation>

You will need to use the associated SoapIn and SoapOut messages:

<message name="WUActionSoapIn">
<part name="parameters" element="tns:WUAction"/>
</message>
<message name="WUActionSoapOut">
<part name="parameters" element="tns:WUActionResponse"/>
</message>

[GordonSmith]

FYI - I tidied up the util folder a bit in this draft PR: jeclrsg#1

[GordonSmith]

I have no idea what this looks like, but does this catch enums with only 2 options (TRUE|FALSE)?

[jeclrsg]

Added a comment to this. Looking at it again, realized that regex wasn't matching value(s) of an enum, but the string that node soap generates to represent an enum, which is always EnumName|type|values

[jeclrsg]

I noticed there was a small issue where the members of the generated TS interfaces were being delimited by commas instead of semi-colons. That seems to be technically valid, but I thought I would go ahead and have them be replaced with semi-colons for consistency (https://typescript-eslint.io/rules/member-delimiter-style). I also squashed & rebased to trunk, so hopefully I didn't miss anything when merging the conflicts in package.json.

[jeclrsg]

I think I covered the most recent requests for changes - the path where the .ts files are written is now of the format .../ServiceName/v#/ServiceName.ts, and the body of each operation is calling the connection wrapper around the service call.

I changed the usage comments slightly as well, noting that you can alternatively pass a local path to a WSDL file as well as a URL. Rodrigo was nice enough to provide me with a copy of the ws_logaccess WSDL yesterday afternoon.

[GordonSmith]

The request interface need to optional either by:

WUQuery(request: Partial<WsWorkunits.WUQuery>): Promise<WsWorkunits.WUQueryResponse> {
	return this._connection.send("WUQuery", request);
}

or

export interface WUQuery {
    Wuid?: string;
    Type?: string;
    Cluster?: string;
    RoxieCluster?: string;
    Owner?: string;
    State?: string;
    StartDate?: string;
    EndDate?: string;
    ECL?: string;
    Jobname?: string;
    LogicalFile?: string;
    LogicalFileSearchType?: string;
...
}

I suspect the later is needed for nested structures

[GordonSmith]

See comment re optional fields in the reqeusts