Sometimes now-sdk dependencies generates any types for OOB Script Includes?

[chaorace]

I notice that a lot of OoB script includes fail to generate a real type definition when using now-sdk dependencies.
(SDK version: 3.0.2)

For example, if I add a script like this to src/fluent/example.js...

new global.ArrayUtil(); // Downloads expected typing
new global.Stream(function() {}); // Downloads "any" typing

... this is the resulting @types/servicenow/script-includes-server.d.ts after invoking now-sdk dependencies:

//Generated by ServiceNow SDK

declare const Class: any

declare namespace global {
declare class ArrayUtil{ initialize() contains(array?,element?) indexOf(array?,item?,startIndex?) ensureArray(obj?) concat(parent?,children?) convertArray(a?) diff() intersect() union() unique(a1?) }

declare const Stream: any
}

I imagine this must be based on the same intellisense generation used by the monaco-based script editor? If so, is it best to assume that the quality of these generated types will remain as-is for the foreseeable future?

[bryce-godfrey]

You are correct, we are using the same ones that come from the instance for the monaco editor. We are hoping to enhance these in the future so you get better types, but since the script includes are just javascript we need to run that through something better at inferring those from the code (AI?) or leverage JSDocs if they have them.

[chaorace]

I've found that running tsc on unannotated script includes usually generates usable types, even in situations where Rhino's current intellisense is outright giving up.
More or less just like this: tsc ./script-include.js --declaration --allowJs --emitDeclarationOnly --outDir types

Here's what tsc generates for NiceError, which I think constitutes a decent benchmark. Not amazing by any means, but much better than the any Rhino intellisense yields:

declare function NiceError(message: any): void;
declare class NiceError {
    constructor(message: any);
    message: any;
    stack: any;
    time: Date;
    toString(): string;
}
declare namespace NiceError {
    function getStackTrace(topLinesToRemove: any): any;
    function _makeStackTraceFriendly(stackTrace: any, topLinesToRemove: any): any;
    function _stripIndentationFromStackTrace(stacktrace: any, topLinesToRemove: any): any;
    namespace SCRIPT_TABLES_WITH_NAME_FIELD {
        let sys_script: string;
        let sys_trigger: string;
        let sys_atf_step: string;
        let sys_ui_action: string;
        let sysauto_script: string;
        let sys_script_fix: string;
        let sys_web_service: string;
        let sys_script_include: string;
        let sc_cat_item_producer: string;
        let sys_transform_script: string;
    }
    let LINE_REGEX: RegExp;
    function _getDistinctScriptTables(stacktrace: any): string[];
    let _friendlyNameCache: {};
    function _getFriendlyScriptNamesForEachTableWithId(scriptTables: any): any;
    function _getScope(glideRecord: any): string;
    function _addScriptNamesToStackTrace(stackTrace: any, friendlyNames: any): any;
    /**
     * Calls `gs.error()` with error message then throws an Error with the same message.
     * Creates a more developer-friendly stack trace than normally provided by the platform.
     * @param {string} errorMessage
     * @throws {Error}
     */
    function raise(errorMessage: string): never;
}

[chaorace]

In any case, until the generation improves here's my workaround for those interested.

tsconfig.json (non-relevant config omitted)

{
  "compilerOptions": {
    "paths": {
      "@servicenow/glide/*": [
        "./@types/glide/*",
        "./node_modules/@servicenow/glide/*"
      ]
    }
  }
}

@types/glide/global/NiceError.d.ts

// This is an example declaration. Obviously use a different naming and content for your own declarations!
// Note how this is in a "global" subfolder. This means it's refering to `global.NiceError`
// (use a different subfolder if you're declaring a class which comes from a different scope)
export declare class NiceError {
    constructor(message: string);
    message: string;
    stack: string;
    time: Date;
    static getStackTrace(topLinesToRemove: number): string;
    /**
     * Calls `gs.error()` with error message then throws an Error with the same message.
     * Creates a more developer-friendly stack trace than normally provided by the platform.
     * @param {string} errorMessage
     * @throws {NiceError}
     */
    static raise(errorMessage: string): never;
}

@types/glide/global/index.d.ts

// Add a new line here for each new declaration file you create
// All scope subfolders you introduce will also need their own index files (same pattern)
export * from './NiceError.d.ts'

src/server/script.ts

// Imports work the same way as the standard ones in @servicenow/glide
// Note however the inclusion of the namespace (global here) in the import path
import { NiceError } from '@servicenow/glide/global'
NiceError.raise('Successfully failed!');