Webviewer: add an optional ScriptName to options

[toddgeist]

This is a feature request for a way to optionally Add a different script to use instead of the default, execute date, API script. The reason why this is useful, is it sometimes you want to do something else that’s not standard as part of that script. For example you may want to pre-process the query or post process the results as part of a normal execute date API request.

You wouldn’t want to use a single execute data API request script and your FileMaker file to do all of this because you’d have to have lots of different conditional branching based on the request object that’s coming in. It would be far easier if you could just call a different script for those times that you want special processing or pre-processing or post processing

Makes sense?

[toddgeist]

@eluce2

[eluce2]

This can already be done at the top client level or by having multiple configs for the typegen to generate multiple clients. But you're saying that you want to pass an optional script name to override this at the lowest level client methods?

This would actually be tricky to do because that param is defined within the adapter, and those types don't flow down through to the individual methods

[toddgeist]

Multiple Clients feels very complex.
I get that this is tricky, though.

[toddgeist]

how about this.

generate the client as normal. But then allow you to create a new Client with a different Script name. That new Client can be used as before. This way you don't have to add options to all the methods.

const customScriptClient = client.changeScriptName("newScriptName")

Is that easier?

[eluce2]

Sort of, that's what you can do now with the current versions, just that you have to generate the a new client rather than change it at runtime, since the script name is defined in the adapter

  export const client = DataApi({
      adapter: new WebViewerAdapter({ scriptName: "ExecuteDataApi" }),
      layout: "API_Contacts",
      schema: { fieldData: ZContacts },
  });

  export const client2 = DataApi({
    adapter: new WebViewerAdapter({ scriptName: "OtherScriptName" }),
    layout: "API_Contacts",
    schema: { fieldData: ZContacts },
});

If you want to do this within typegen, just define an array of configs in the proofkit-typegen-config.jsonc file