@servicenow/sdk-build-core 2.0.1

package/dist/util/Debug.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Debug.js","sourceRoot":"","sources":["../../src/util/Debug.ts"],"names":[],"mappings":";;AAIA,0BAMC;AAED,8BAcC;AAED,wCAYC;AAED,gCAGC;AA7CD,+BAA6C;AAC7C,oDAA2D;AAG3D,SAAgB,OAAO,CAAC,GAAY,EAAE,KAAK,GAAG,CAAC;IAC3C,OAAO,IAAA,cAAW,EAAC,GAAG,EAAE;QACpB,MAAM,EAAE,IAAI;QACZ,OAAO,EAAE,KAAK;QACd,KAAK;KACR,CAAC,CAAA;AACN,CAAC;AAED,SAAgB,SAAS,CAAC,IAAkC,EAAE,MAAc,EAAE,OAAO,GAAG,OAAO;IAC3F,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACpB,MAAM,CAAC,IAAI,CACP,OAAO,CACH,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACX,IAAI,CAAC,YAAY,gBAAI,EAAE,CAAC;YACpB,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAA;QACvB,CAAC;aAAM,CAAC;YACJ,OAAO,CAAC,CAAA;QACZ,CAAC;IACL,CAAC,CAAC,EACF,CAAC,CACJ,CACJ,CAAA;AACL,CAAC;AAED,SAAgB,cAAc,CAAC,SAAqB,EAAE,MAAc,EAAE,OAAO,GAAG,YAAY;IACxF,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACpB,MAAM,CAAC,IAAI,CACP,OAAO,CACH,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAChB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,CAAC,CAAA;QAC3B,IAAI,CAAA;QACJ,OAAO,IAAI,CAAA;IACf,CAAC,CAAC,EACF,CAAC,CACJ,CACJ,CAAA;AACL,CAAC;AAED,SAAgB,UAAU,CAAC,KAAa,EAAE,MAAc,EAAE,OAAO,GAAG,QAAQ;IACxE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACpB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAA;AAClC,CAAC"}

package/dist/util/Util.d.ts

@@ -0,0 +1,4 @@
+import { FileSystem } from '@servicenow/sdk-project';
+export declare const NOW_DIR = ".now";
+export declare function safeWriteFileToPath(fs: FileSystem, dirPath: string, fileName: string, content: string, encoding?: FileSystem.Encoding): void;
+export declare function createDirIfNotExists(dirPath: string, fs: FileSystem): void;

package/dist/util/Util.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NOW_DIR = void 0;
+exports.safeWriteFileToPath = safeWriteFileToPath;
+exports.createDirIfNotExists = createDirIfNotExists;
+const path = __importStar(require("path"));
+const sdk_project_1 = require("@servicenow/sdk-project");
+exports.NOW_DIR = '.now';
+function safeWriteFileToPath(fs, dirPath, fileName, content, encoding = 'utf-8') {
+    createDirIfNotExists(dirPath, fs);
+    fs.writeFileSync(path.join(dirPath, fileName), content, { encoding: encoding });
+}
+function createDirIfNotExists(dirPath, fs) {
+    if (!sdk_project_1.FileSystem.existsSync(fs, dirPath)) {
+        fs.mkdirSync(dirPath, { recursive: true });
+    }
+}
+//# sourceMappingURL=Util.js.map

package/dist/util/Util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Util.js","sourceRoot":"","sources":["../../src/util/Util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,kDASC;AAED,oDAIC;AApBD,2CAA4B;AAC5B,yDAAoD;AAEvC,QAAA,OAAO,GAAG,MAAM,CAAA;AAE7B,SAAgB,mBAAmB,CAC/B,EAAc,EACd,OAAe,EACf,QAAgB,EAChB,OAAe,EACf,WAAgC,OAAO;IAEvC,oBAAoB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IACjC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAA;AACnF,CAAC;AAED,SAAgB,oBAAoB,CAAC,OAAe,EAAE,EAAc;IAChE,IAAI,CAAC,wBAAU,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC;QACtC,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAC9C,CAAC;AACL,CAAC"}

package/dist/util/XMLJsonBuilder.d.ts

@@ -0,0 +1,18 @@
+export declare class XMLJsonBuilder {
+    private rootXmlElement;
+    constructor(version: string);
+    createRoot(element: string, text?: string, attrs?: Record<string, string | number | boolean>): XMLJsonElement;
+    buildJsonObj(): any;
+}
+export declare class XMLJsonElement {
+    private element;
+    private text;
+    private attrs;
+    private isCDATA;
+    private xmlEleMap;
+    constructor(element: string, text?: string, attrs?: Record<string, string | number | boolean>, isCDATA?: boolean);
+    addJsonObj(element: string, text?: string, attrs?: Record<string, string | number | boolean>, isCDATA?: boolean): XMLJsonElement;
+    getData(): {
+        [x: string]: any;
+    };
+}

package/dist/util/XMLJsonBuilder.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XMLJsonElement = exports.XMLJsonBuilder = void 0;
+class XMLJsonBuilder {
+    rootXmlElement;
+    constructor(version) {
+        this.rootXmlElement = new XMLJsonElement('_root');
+        this.rootXmlElement.addJsonObj('?xml', undefined, { version });
+    }
+    createRoot(element, text = '', attrs = {}) {
+        return this.rootXmlElement.addJsonObj(element, text, attrs);
+    }
+    buildJsonObj() {
+        const { _root: { '#text': _rootText, ...jsonObj }, } = this.rootXmlElement.getData();
+        return jsonObj;
+    }
+}
+exports.XMLJsonBuilder = XMLJsonBuilder;
+class XMLJsonElement {
+    element;
+    text;
+    attrs;
+    isCDATA;
+    xmlEleMap = new Map();
+    constructor(element, text = '', attrs = {}, isCDATA = false) {
+        this.element = element;
+        this.text = text;
+        this.attrs = attrs;
+        this.isCDATA = isCDATA;
+    }
+    addJsonObj(element, text = '', attrs = {}, isCDATA = false) {
+        const xmlJsonObj = new XMLJsonElement(element, text, attrs, isCDATA);
+        if (!this.xmlEleMap.has(element)) {
+            this.xmlEleMap.set(element, []);
+        }
+        this.xmlEleMap.get(element).push(xmlJsonObj);
+        return xmlJsonObj;
+    }
+    getData() {
+        const additionalElements = [];
+        this.xmlEleMap.forEach((value, key) => {
+            if (value.length === 1) {
+                additionalElements.push({ ...value[0].getData() });
+                return;
+            }
+            additionalElements.push({ [key]: value.map((value) => value.getData()[key]) });
+        });
+        const additionalObj = additionalElements.reduce((acc, ele) => ({ ...acc, ...ele }), {});
+        return {
+            [this.element]: {
+                ...(this.isCDATA ? { __cdata: this.text } : { '#text': this.text }),
+                ...Object.fromEntries(Object.entries(this.attrs).map(([k, v]) => [`@_${k}`, v])),
+                ...additionalObj,
+            },
+        };
+    }
+}
+exports.XMLJsonElement = XMLJsonElement;
+//# sourceMappingURL=XMLJsonBuilder.js.map

package/dist/util/XMLJsonBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XMLJsonBuilder.js","sourceRoot":"","sources":["../../src/util/XMLJsonBuilder.ts"],"names":[],"mappings":";;;AAAA,MAAa,cAAc;IACf,cAAc,CAAgB;IACtC,YAAY,OAAe;QACvB,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,CAAA;QACjD,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;IAClE,CAAC;IAED,UAAU,CAAC,OAAe,EAAE,OAAe,EAAE,EAAE,QAAmD,EAAE;QAChG,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;IAC/D,CAAC;IAED,YAAY;QACR,MAAM,EACF,KAAK,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,GAC5C,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAA;QACjC,OAAO,OAAO,CAAA;IAClB,CAAC;CACJ;AAjBD,wCAiBC;AAED,MAAa,cAAc;IAIX;IACA;IACA;IACA;IANJ,SAAS,GAAkC,IAAI,GAAG,EAAE,CAAA;IAE5D,YACY,OAAe,EACf,OAAe,EAAE,EACjB,QAAmD,EAAE,EACrD,UAAmB,KAAK;QAHxB,YAAO,GAAP,OAAO,CAAQ;QACf,SAAI,GAAJ,IAAI,CAAa;QACjB,UAAK,GAAL,KAAK,CAAgD;QACrD,YAAO,GAAP,OAAO,CAAiB;IACjC,CAAC;IAEJ,UAAU,CACN,OAAe,EACf,OAAe,EAAE,EACjB,QAAmD,EAAE,EACrD,UAAmB,KAAK;QAExB,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;QACpE,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;QACnC,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC7C,OAAO,UAAU,CAAA;IACrB,CAAC;IAED,OAAO;QACH,MAAM,kBAAkB,GAAQ,EAAE,CAAA;QAClC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAClC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACrB,kBAAkB,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;gBACnD,OAAM;YACV,CAAC;YACD,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAA;QAClF,CAAC,CAAC,CAAA;QAEF,MAAM,aAAa,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;QAEvF,OAAO;YACH,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;gBACZ,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;gBACnE,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;gBAChF,GAAG,aAAa;aACnB;SACJ,CAAA;IACL,CAAC;CACJ;AA5CD,wCA4CC"}

package/dist/util/XMLUploadParser.d.ts

@@ -0,0 +1,22 @@
+declare enum Action {
+    INSERT_OR_UPDATE = "INSERT_OR_UPDATE",
+    DELETE = "DELETE",
+    DELETE_MULTIPLE = "delete_multiple"
+}
+export type Record = {
+    table: string;
+    action: Action;
+    id: string;
+    data: {
+        [element: string]: string | undefined | boolean | number;
+    };
+};
+export declare class XMLUnloadParser {
+    readonly records: Record[];
+    static parse: (xml: string) => XMLUnloadParser;
+    private parse;
+    private processResult;
+    private parseRecord;
+    private parseAction;
+}
+export {};

package/dist/util/XMLUploadParser.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XMLUnloadParser = void 0;
+const fast_xml_parser_1 = require("fast-xml-parser");
+var Action;
+(function (Action) {
+    Action["INSERT_OR_UPDATE"] = "INSERT_OR_UPDATE";
+    Action["DELETE"] = "DELETE";
+    Action["DELETE_MULTIPLE"] = "delete_multiple";
+})(Action || (Action = {}));
+class XMLUnloadParser {
+    records = [];
+    static parse = (xml) => {
+        const parser = new XMLUnloadParser();
+        parser.parse(xml);
+        return parser;
+    };
+    parse = (xml) => {
+        const parsed = new fast_xml_parser_1.XMLParser({
+            ignoreAttributes: false,
+            alwaysCreateTextNode: false,
+            ignoreDeclaration: true,
+        }).parse(xml, true);
+        this.processResult(parsed);
+    };
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    processResult(result) {
+        const recordUpdate = result['record_update'];
+        for (const tag in recordUpdate) {
+            if (!tag.startsWith('@') && typeof recordUpdate[tag] === 'object') {
+                const records = recordUpdate[tag];
+                if (Array.isArray(records)) {
+                    for (const record of records) {
+                        this.parseRecord(tag, record);
+                    }
+                }
+                else {
+                    this.parseRecord(tag, recordUpdate[tag]);
+                }
+            }
+        }
+    }
+    parseRecord(table, record) {
+        const { '@_action': action, sys_id, ...data } = record;
+        const parsedAction = this.parseAction(action);
+        this.records.push({
+            table,
+            action: parsedAction,
+            id: sys_id || 'unknown',
+            data,
+        });
+    }
+    parseAction(actionStr) {
+        switch (actionStr) {
+            case 'INSERT_OR_UPDATE':
+                return Action.INSERT_OR_UPDATE;
+            case 'DELETE':
+                return Action.DELETE;
+            case 'delete_multiple':
+                return Action.DELETE_MULTIPLE;
+            default:
+                throw new Error(`Invalid action string: ${actionStr}`);
+        }
+    }
+}
+exports.XMLUnloadParser = XMLUnloadParser;
+//# sourceMappingURL=XMLUploadParser.js.map

package/dist/util/XMLUploadParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"XMLUploadParser.js","sourceRoot":"","sources":["../../src/util/XMLUploadParser.ts"],"names":[],"mappings":";;;AAAA,qDAA2C;AAE3C,IAAK,MAIJ;AAJD,WAAK,MAAM;IACP,+CAAqC,CAAA;IACrC,2BAAiB,CAAA;IACjB,6CAAmC,CAAA;AACvC,CAAC,EAJI,MAAM,KAAN,MAAM,QAIV;AASD,MAAa,eAAe;IACf,OAAO,GAAa,EAAE,CAAA;IAE/B,MAAM,CAAC,KAAK,GAAG,CAAC,GAAW,EAAE,EAAE;QAC3B,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAA;QACpC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAEjB,OAAO,MAAM,CAAA;IACjB,CAAC,CAAA;IAEO,KAAK,GAAG,CAAC,GAAW,EAAE,EAAE;QAC5B,MAAM,MAAM,GAAG,IAAI,2BAAS,CAAC;YACzB,gBAAgB,EAAE,KAAK;YACvB,oBAAoB,EAAE,KAAK;YAC3B,iBAAiB,EAAE,IAAI;SAC1B,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;QAEnB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;IAC9B,CAAC,CAAA;IAED,8DAA8D;IACtD,aAAa,CAAC,MAAmD;QACrE,MAAM,YAAY,GAAG,MAAM,CAAC,eAAe,CAAC,CAAA;QAE5C,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,OAAO,YAAY,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAChE,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,CAAA;gBACjC,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBACzB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;wBAC3B,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;oBACjC,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACJ,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAA;gBAC5C,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAEO,WAAW,CAAC,KAAa,EAAE,MAA6B;QAC5D,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAA;QAEtD,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAE7C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YACd,KAAK;YACL,MAAM,EAAE,YAAY;YACpB,EAAE,EAAG,MAAiB,IAAI,SAAS;YACnC,IAAI;SACP,CAAC,CAAA;IACN,CAAC;IAEO,WAAW,CAAC,SAAiB;QACjC,QAAQ,SAAS,EAAE,CAAC;YAChB,KAAK,kBAAkB;gBACnB,OAAO,MAAM,CAAC,gBAAgB,CAAA;YAClC,KAAK,QAAQ;gBACT,OAAO,MAAM,CAAC,MAAM,CAAA;YACxB,KAAK,iBAAiB;gBAClB,OAAO,MAAM,CAAC,eAAe,CAAA;YACjC;gBACI,MAAM,IAAI,KAAK,CAAC,0BAA0B,SAAS,EAAE,CAAC,CAAA;QAC9D,CAAC;IACL,CAAC;;AA9DL,0CA+DC"}

package/dist/util/index.d.ts

@@ -0,0 +1,4 @@
+export * from './Debug';
+export * from './Util';
+export * from './XMLUploadParser';
+export * from './XMLJsonBuilder';

package/dist/util/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Debug"), exports);
+__exportStar(require("./Util"), exports);
+__exportStar(require("./XMLUploadParser"), exports);
+__exportStar(require("./XMLJsonBuilder"), exports);
+//# sourceMappingURL=index.js.map

package/dist/util/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,yCAAsB;AACtB,oDAAiC;AACjC,mDAAgC"}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 ServiceNow Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@servicenow/sdk-build-core",
+  "version": "2.0.1",
+  "description": "ServiceNow SDK Build System Core Libraries",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@ts-morph/common": "0.24.0",
+    "fast-xml-parser": "4.4.1",
+    "lodash": "4.17.21",
+    "ts-morph": "23.0.0",
+    "zod": "3.22.4",
+    "@servicenow/sdk-core": "2.0.1",
+    "@servicenow/sdk-project": "2.0.1",
+    "@servicenow/sdk-metrics": "2.0.1"
+  },
+  "overrides": {
+    "micromatch": "^4.0.7"
+  },
+  "devDependencies": {
+    "@types/lodash": "4.14.195",
+    "junk": "3.1.0",
+    "memfs": "^4.8.1"
+  },
+  "engines": {
+    "node": ">=18.16.1",
+    "pnpm": ">=9.4.0"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "clean": "tsc -b --clean",
+    "lint": "eslint . --ext .ts",
+    "prettier:check": "prettier --check --ignore-path=../../.prettierignore .",
+    "prettier:write": "prettier --write --ignore-path=../../.prettierignore .",
+    "watch": "tsc -b -w",
+    "test": "tsc -b tsconfig.test.json && export NODE_OPTIONS=\"--max-old-space-size=8192 --experimental-vm-modules\" && jest --colors --reporters=default --no-cache --logHeapUsage"
+  }
+}

package/src/BuildOptions.ts

@@ -0,0 +1,27 @@
+import * as path from 'path'
+import * as z from 'zod'
+
+const BuildOptionsSchema = z
+    .object({
+        mode: z.string(),
+        release: z.string().default('default'),
+        debug: z.boolean().default(false),
+        dontSaveFiles: z.boolean().default(false),
+    })
+    .and(
+        z
+            .object({
+                mode: z.literal('serialize'),
+            })
+            .or(
+                z.object({
+                    mode: z.literal('transform'),
+                    clean: z.boolean().default(false),
+                    transformDirectory: z.string().default(path.resolve(process.cwd(), 'incoming')),
+                })
+            )
+    )
+
+export type BuildOptionsInput = z.input<typeof BuildOptionsSchema>
+export type BuildOptions = z.output<typeof BuildOptionsSchema>
+export const parseBuildOptions = BuildOptionsSchema.parse

package/src/GUID.ts

@@ -0,0 +1,26 @@
+import * as crypto from 'crypto'
+
+const HASH_ALGORITHM = 'md5'
+const HASH_DIGEST = 'hex'
+const HASH_SEPARATOR = ':'
+
+export function GUID(...parts: unknown[]) {
+    if (parts.length === 0) {
+        return crypto.randomUUID().replaceAll('-', '')
+    }
+
+    const hash = crypto.createHash(HASH_ALGORITHM)
+    hash.update(parts.join(HASH_SEPARATOR))
+    return hash.digest(HASH_DIGEST)
+}
+
+// Matches a hex string exactly 32 characters long
+const snIDRegex = /^[a-f0-9]{32}$/i
+
+export function isGUID(guid: string | number): guid is string {
+    if (typeof guid !== 'string') {
+        return false
+    }
+
+    return snIDRegex.test(guid)
+}

package/src/Keys.ts

@@ -0,0 +1,287 @@
+import { SourceFile, ModuleDeclarationKind, PropertySignatureStructure, OptionalKind } from 'ts-morph'
+import * as path from 'path'
+import { parseType } from './TypeScript'
+import { GUID, isGUID } from './GUID'
+import * as z from 'zod'
+import * as _ from 'lodash'
+import { Context } from './plugins'
+import { FileSystem } from '@servicenow/sdk-project'
+
+export const KEYS_MODULE = '@servicenow/sdk/global'
+export const KEYS_FILE_NAME = 'keys.ts'
+
+const KeysSchema = z.object({
+    explicit: z
+        .record(
+            z.string().or(z.number()),
+            z.object({
+                table: z.string(),
+                id: z.string(),
+            })
+        )
+        .default({}),
+    composite: z
+        .array(
+            z.object({
+                table: z.string(),
+                id: z.string(),
+                key: z.record(z.string(), z.string().or(z.number())),
+            })
+        )
+        .default([]),
+    deleted: z.record(z.array(z.string())).default({}),
+})
+
+export class Keys implements Now.Internal.KeysRegistry {
+    private readonly keys: Now.Internal.KeysRegistry
+    private readonly usedIds: Set<string> = new Set()
+
+    constructor(context: Context) {
+        this.keys = Keys.parseKeysFile(context) ?? { explicit: {}, composite: [], deleted: {} }
+    }
+
+    private static parseKeysFile(context: Context): Now.Internal.KeysRegistry | undefined {
+        const keysFile = Keys.getKeysFile(context)
+        if (!keysFile) {
+            return undefined
+        }
+
+        const keysInterface = Keys.getOrCreateKeysInterface(keysFile)
+        return KeysSchema.parse(
+            parseType(keysInterface.getType(), keysInterface, (unparsableType) => {
+                if (unparsableType.isArray()) {
+                    return [] // If the keys file doesn't have composite keys, it will be an unparsable array so just return an empty one
+                } else {
+                    throw `Unparsable type in keys.ts: ${unparsableType.getText()}`
+                }
+            })
+        )
+    }
+
+    private static getKeysFile(context: Context): SourceFile | undefined {
+        const keysFilePath = Keys.getKeysFilePath(context)
+        if (!FileSystem.existsSync(context.fs, keysFilePath)) {
+            // BUG: It shouldn't be necessary to check manually here, but there is a bug in
+            // ts-morph where attempting to add a source file that doesn't exist will cause
+            // subsequent operations on the parent directory to fail in certain scenarios.
+            //
+            // Created an issue here: https://github.com/dsherret/ts-morph/issues/1554
+            return undefined
+        }
+
+        return context.compiler.addSourceFileAtPathIfExists(keysFilePath)
+    }
+
+    public static getKeysFilePath(context: Context) {
+        return path.resolve(context.app.rootDir, context.app.config.generatedDir, KEYS_FILE_NAME)
+    }
+
+    private static createKeysFile(context: Context): SourceFile {
+        const keysFilePath = Keys.getKeysFilePath(context)
+        const parentDir = path.dirname(keysFilePath)
+        context.fs.mkdirSync(parentDir, { recursive: true })
+        const keysFile = context.compiler.createSourceFile(keysFilePath, '', {})
+        Keys.ensureGlobalImport(keysFile)
+
+        return keysFile
+    }
+
+    private static ensureGlobalImport(keysFile: SourceFile) {
+        if (!keysFile.getImportDeclaration((i) => i.getModuleSpecifierValue() === KEYS_MODULE)) {
+            keysFile.addImportDeclaration({ moduleSpecifier: KEYS_MODULE })
+        }
+    }
+
+    private static getOrCreateKeysInterface(keysFile: SourceFile) {
+        const declareGlobal =
+            keysFile.getModule('global') ??
+            keysFile.addModule({
+                name: 'global',
+                declarationKind: ModuleDeclarationKind.Global,
+                hasDeclareKeyword: true,
+            })
+
+        const nowNamespace =
+            declareGlobal.getModule('Now') ??
+            declareGlobal.addModule({
+                name: 'Now',
+                declarationKind: ModuleDeclarationKind.Namespace,
+            })
+
+        const internalNamespace =
+            nowNamespace.getModule('Internal') ??
+            nowNamespace.addModule({
+                name: 'Internal',
+            })
+
+        return (
+            internalNamespace.getInterface('Keys') ??
+            internalNamespace.addInterface({
+                name: 'Keys',
+                extends: (writer) => {
+                    writer.write('KeysRegistry')
+                },
+            })
+        )
+    }
+
+    private use(id: string) {
+        this.usedIds.add(id)
+        return id
+    }
+
+    get explicit() {
+        return this.keys.explicit
+    }
+
+    get composite() {
+        return this.keys.composite
+    }
+
+    get deleted() {
+        return this.keys.deleted
+    }
+
+    getNextAvailableExplicitKey() {
+        for (let i = 0; ; i++) {
+            const key = `generated${i}`
+            if (!this.explicit[key]) {
+                return key
+            }
+        }
+    }
+
+    findExplicitKeyById(id: string) {
+        return Object.entries(this.explicit).find(([, v]) => v.id === id)?.[0]
+    }
+
+    registerExplicitId(table: string, key: string | number, sysIdOverride?: string): string {
+        if (isGUID(key)) {
+            // WARNING:
+            //
+            // IT IS CRITICAL THAT KEYS ARE NOT REGISTERED FOR THINGS OUTSIDE OF THE APP. IF KEYS ARE
+            // REGISTERED FOR THINGS THAT COME FROM THE CORE PLATFORM OR SOME OTHER APP, THERE IS RISK
+            // THAT THEY WILL BE DELETED ACCIDENTALLY BY THE CUSTOMER.
+            //
+            // THIS CHECK IS HERE AS AN EXTRA DEFENSIVE MEASURE TO MAKE SURE EXTERNAL SYS IDS ARE NOT
+            // ACCIDENTALLY REGISTERED AS LOCAL KEYS.
+            //
+            // TODO: We need to come up with a different system for key registration where external
+            // keys can be resolved to sys IDs without registering them as local keys.
+            return this.use(this.explicit[key]?.id ?? key)
+        }
+
+        const existing = this.explicit[key]
+        if (existing) {
+            if (existing.table !== table) {
+                throw `Explicit key '${key}' is already registered for table '${existing.table}', cannot register for table '${table}'`
+            }
+
+            return this.use(existing.id)
+        }
+
+        if (sysIdOverride) {
+            const existingKey = this.findExplicitKeyById(sysIdOverride)
+            if (existingKey) {
+                const existingWithSysId = this.explicit[existingKey]!
+                if (existingWithSysId.table !== table) {
+                    throw `ID '${sysIdOverride}' is already registered for table '${existingWithSysId.table}', cannot register for table '${table}'`
+                }
+
+                if (existingKey !== (key as string | number)) {
+                    throw `ID '${sysIdOverride}' is already registered for key '${existingKey}', cannot register for key '${key}'`
+                }
+
+                return this.use(existingWithSysId.id)
+            }
+        }
+
+        const newKey = {
+            table,
+            id: isGUID(key) ? (key as string) : sysIdOverride ?? GUID(),
+        }
+
+        this.explicit[key] = newKey
+        return this.use(newKey.id)
+    }
+
+    registerCompositeId(table: string, key: Record<string, string | number>, sysIdOverride?: string): string {
+        const existing = this.composite.find((k) => k.table === table && _.isEqual(k.key, key))
+        if (existing) {
+            if (existing.table !== table) {
+                throw `Composite key ${key} is already registered for table '${existing.table}', cannot register for table '${table}'`
+            }
+
+            return this.use(existing.id)
+        }
+
+        const newKey = {
+            table,
+            id: sysIdOverride ?? GUID(),
+            key,
+        }
+
+        this.composite.push(newKey)
+        return this.use(newKey.id)
+    }
+
+    getUsedExplicitIds() {
+        return Object.fromEntries(Object.entries(this.explicit).filter(([, v]) => this.usedIds.has(v.id)))
+    }
+
+    getUsedCompositeIds() {
+        return this.composite.filter((v) => this.usedIds.has(v.id))
+    }
+
+    // TODO: This is called in multiple places and is not very cheap. We should consider optimization options.
+    getDeletedAndUnusedIds() {
+        return [
+            ...Object.values(this.explicit),
+            ...this.composite,
+            ...Object.entries(this.deleted).flatMap(([k, v]) => v.map((id) => ({ table: k, id }))),
+        ]
+            .filter((v) => !this.usedIds.has(v.id))
+            .reduce(
+                (deletedIds, v) => {
+                    deletedIds[v.table] = [...(deletedIds[v.table] ?? []), v.id]
+                    return deletedIds
+                },
+                {} as Record<string, string[]>
+            )
+    }
+
+    async save(context: Context, formatter?: (file: SourceFile) => Promise<void>) {
+        const newProperties: OptionalKind<PropertySignatureStructure>[] = []
+        const usedExplicitIds = this.getUsedExplicitIds()
+        const usedCompositeIds = this.getUsedCompositeIds()
+        const deletedOrUnusedIds = this.getDeletedAndUnusedIds()
+
+        if (Object.keys(usedExplicitIds).length > 0) {
+            newProperties.push({
+                name: 'explicit',
+                type: JSON.stringify(usedExplicitIds, undefined, 4),
+            })
+        }
+
+        if (usedCompositeIds.length > 0) {
+            newProperties.push({
+                name: 'composite',
+                type: JSON.stringify(usedCompositeIds, undefined, 4),
+            })
+        }
+
+        if (Object.keys(deletedOrUnusedIds).length > 0) {
+            newProperties.push({
+                name: 'deleted',
+                type: JSON.stringify(deletedOrUnusedIds, undefined, 4),
+            })
+        }
+
+        const keysFile = Keys.getKeysFile(context) ?? Keys.createKeysFile(context)
+        const keysInterface = Keys.getOrCreateKeysInterface(keysFile)
+        keysInterface.getProperties().forEach((p) => p.remove())
+        keysInterface.addProperties(newProperties)
+        await formatter?.(keysFile)
+        keysFile.saveSync()
+    }
+}