Support for sys_script_include (Script Include) via Fluent API?

[arjunbasnet]

Hi team,

We develop scoped application on to of servicenow platform, we utilize custom tooling to support source code development on local machine. However, we do use servicenow platform UI for the development activities that isn't "script" heavy or config type.

we are experimenting with the ServiceNow SDK (v3.x) and planning to migrate on building applications entirely with source code driven by Fluent API. There are two reasons:

1. Our team loves working with source in their code editor (generally VS Code) rather than navigating through various app files/metadata files as record list.
2. ServiceNow Studio (Legacy) has been deprecated. We were using it's source control (git) integration to manage the application version rather than updateset export/import.

However, we have noticed that currently Fluent APIs are limited. One important missing piece for us is sys_script_include (Script Include).
At the moment, we are planning to use Record() to define Script Include manually:
`import { Record } from '@servicenow/sdk/core';

Record({
table: 'sys_script_include',
data: {
name: 'MyHelper',
client_callable: false,
script: ...,
}
});
It does work but the uneasy part is "script" prop/field has to be a string type. It would be convenient if we would have following styleScriptInclude({
name: 'MyHelper',
script: MyHelper,
...
});`

Is this on the roadmap or is there better workaround than using Record().

Thanks.

[bryce-godfrey]

There will be a dedicated ScriptInclude API in the next release, but what we recommend you do in either case is to utilize Now.include to move the contents of that field script to a dedicated file for proper editor support and syntax.
Example:

Record({
 $id: Now.ID['some-value'],
 table: 'sys_script_include',
 data: {
    script: Now.include('./my-script-file.server.js'),
    ...
  }
})

You can then also utilize the now-sdk dependencies command to download the typing information from your instance and add it to your project (goes into @types/servicenow folder) to get intellisense in your js files. Also add a tsconfig.json file to src/fluent to configure intellisense and typing information on the js files.

Example of all this:
https://github.com/ServiceNow/sdk-examples/blob/main/dependencies-sample/src/fluent/script-include.now.ts

[arjunbasnet]

Thank you for the response, the workaround suggested works for now. We will be waiting for dedicated API.