Improvements required in ballerinax/salesforce package

[aashikam]

Description: Tracking improvements required in salesforce connector as I identify areas/bugs that needs fixing during the current revamp sessions.

• [ ] Improve documentation - all API docs needs to be revisited as most looks lack of clarity and does not directly convey the purpose.

• [ ] Although the connector goes by ballerinax/salesforce, API docs mention sfdc:Error and sfdc: in other places.

• [ ] Subrequest - https://central.ballerina.io/ballerinax/salesforce/8.0.2#Subrequest should be SubRequest.

• [ ] Multiple spelling and grammar mistakes in docs:

  

• [ ] Some of the types are never used inside the module or the packages, and some public types are not documented at all.

  

• [ ] Revisit and refactor code base, based on the comments on https://github.com/ballerina-platform/module-ballerinax-salesforce/pull/355

• [ ] Remove the deprecated APIs in this PR: https://github.com/ballerina-platform/module-ballerinax-salesforce/pull/355 with 9.0.0 release

• [ ] These are public, I have deprecated them. Remove with 9.0.0 release

• [ ] Also seems to be an unused enum:

Haven't event used internally in code where it applies. This is from tests.

• [ ] Need to revisit the logic in all tests!

• [ ] The following constants are not made public.

  

  But they are used in tests as follows

  

  But users can't do the same, as these are not public.

• [ ] Use included record params in init ?

  public isolated function init(*ConnectionConfig config) returns error? {
      // implement the init
  }

• [ ] Use check expressions where necessary in tests
• [ ] There is a trap in client init, no idea why, keep if there is a reason or improve code

[Shadow-Devil]

It would be great to have the following remote functions included in the salesforce package so one can use the salesforce:Client to generate the OAS needed for ballerinax/salesforce.types (See here: https://github.com/ballerina-platform/module-ballerinax-salesforce.types?tab=readme-ov-file#step-2-generate-open-api-specification-for-your-sobjects)

Endpoints to add:

• https://MyDomainName.my.salesforce.com/services/data/vXX.X/async/specifications/oas3
• https://MyDomainName.my.salesforce.com/services/data/vXX.X/async/specifications/oas3/LOCATOR_ID

[aashikam]

@Shadow-Devil This is already supported using Ballerina openapi tool. You can do this following this guide: https://github.com/ballerina-platform/module-ballerinax-salesforce.types

We are in the process of bringing this types package inside ballerinax/salesforce. But note that this only includes the basic types and not custom ones. You can follow the README.md to generate your own Salesforce types module which will include the custom objects as well. https://github.com/ballerina-platform/module-ballerinax-salesforce.types