SDK 4.4.0

[bryce-godfrey]

@servicenow/sdk — Release Notes

Version: 4.4.0
Availability: npm — https://www.npmjs.com/package/@servicenow/sdk

---

🚀 Overview

Version 4.4.0 fixes some bugs and adds a new dev server capability for front end UI building with the SDK, and some internal support for future version of Build Agent!

---

New Features

Global App Support

Global apps are now supported by the SDK, see this announcement here: #40 for more information on that.

Front-End Dev Server

A highly requested feature — the dev server drastically reduces build cycles and enables rapid UI development without needing to deploy to an instance. Requests are proxied to the ServiceNow instance defined in your auth credentials.

Note: Dev server scripts are included in new projects only. A future release will add a command to install it into existing projects.

Getting started:

1. Run sdk init using the react or vue template
2. Start the server with npm run dev

Requirements:

• @servicenow/isomorphic-rollup >= 1.2.14
• @servicenow/sdk >= 4.4.0
• now.dev.mjs present in your project (generated during init)

---

ServiceCatalog & Flows

Add support between Flows and ServiceCatalog in Fluent for interacting with catalog variables and actions in Flows, and for Catalog Items to trigger Flows!

• Support for Flow Service Catalog Item triggers
• Support for getCatalogVariables action in Flows
• Support for `createCatalogTask' action in Flows
• Support for submitCatalogItemRequest action in Flows

See sdk-examples Flow samples

Changes

• Fix invalid transformation for duration field for Sla
• Fix requestMethod on CatalogItem and CatalogItemProducer not serializing properly
• Stable UX asset IDs (will see keys.ts location changes)
• Add protectionPolicy to ACL
• Add tableDefaultLanguage to now.config.json to support setting language on table column labels
• Fix APIs that were not restricting arbitrary properties!

NOTE: Many APIs were not strictly enforcing that extra properties could not be defined on the API, which caused some usage errors around mispelling properties or thinking they can add a property and it will be added to the build output.

For example this would not produce an error:

Property({
 $id: Now.ID['property-1'],
 name: 'x_foo.myproperty',
 randomProperty: true
})

This will now produce an error diagnostic that randomProperty does not exist as an option on Property! This may introduce a build error for existing projects when upgrading to 4.4.0, but these properties were being ignored during build causing false positives.

---

This discussion was created from the release SDK 4.4.0.

[DanielMadsenDK]

I'm surprised to find that I can choose between Global and Scoped application when initializing a new project. Does that mean Global scope solutions are now finally supported? If so, I think it deserves some space in the release notes, that is a great addition :)

[bryce-godfrey]

This might help #40

[vincepg13]

Good work on the dev server! Guess I can now look into retiring my trusty vite dev server I have been using with my SDK applications.

@bryce-godfrey saying that, did we ever get anywhere with native tailwind support? I still only have support for it via triggering a manual postcss build in the now.prebuild.mjs file. Having it work natively via the tailwind rollup plugin would be ideal

[arjunbasnet]

Great work on dev server! that's exactly what we needed, we have built custom tooling for similar challenges. Can't wait to get hands dirty.

One questions related all the cool things SDK is delivering, will there ever be "unit-tests" mock libraries for server-side APIs? Is there already in the ecosystem?

[bryceg]

We don't have any plans for a mocking library for Glide/Server things in the near term, although it is something I would like to have some support for so you can unit test sys modules at least. Others have put out some options here though like @sonisoft-cnanda that he might be willing to share.

[sonisoft-cnanda]

@arjunbasnet Sorry for it taking a couple days, I have been cleaning things up. I put this out a year ago and no one really had any interest. So you can look at this library (and contribute, please!) which is an initial mocking configuration for ServiceNow APIs. It includes an in-memory database version of GlideRecord so you can verify things work properly for inserts/updates, etc... I need to make some updates on a couple things still based on what I have learned over the past year, but I will do that over the next week.

https://github.com/sonisoft-cnanda/now-sdk-mock

One thing to take note of, in order to mock the ServiceNow API's, Jest at least expects there to be implementations of those classes. The @servicenow/glide library that the SDK team publishes is only a list of type declarations, and will cause some havoc and hair pulling when trying to mock things like GlideRecord in jest.

In order to resolve that, I have created a new version of the @servicenow/glide library that is a derivative of what SN has published, but it reverse-generates stub files for each of the type declarations, making it so Jest won't get upset.

That is locate here: https://github.com/sonisoft-cnanda/servicenow-glide , but I also exported that to npmjs as servicenow-glide, you just need to alias it as the @servicenow/glide library:

npm install --save-dev @servicenow/glide@npm:servicenow-glide

This would take the place of using the @servicenow/glide that SN has published. (@bryce-godfrey Don't worry, I updated the script and updated the library to the newest @servicenow/glide that is published and will keep this as up to date as possible as you guys publish new versions of that library).

I will eventually have the mocking library on NPMJS as well, but am working to get it updated first, so you can build it and link it locally to use it for now.

[sonisoft-cnanda]

FYI This does work with both Typescript and I set it up to be able to initialize a mock rhino environment as well, so you can use it for script includes as well (I put out some videos on this last year on my Youtube channel called NOW Hacks).

[arjunbasnet]

Thanks both. @sonisoft-cnanda that's awesome I will check, the in-memory database is excellent.

[sonisoft-cnanda]

The MockRESTMessage has some easy accessors as well to mock response codes and response data nice and quickly as well.

I was just working on something for this last night as well to better support dot walking. Should have that in there soon.