@servicenow/sdk-build-core 3.0.3 → 4.0.0

package/dist/plugins/cache.d.ts

@@ -0,0 +1,20 @@
+declare class SuccessEntry<T = unknown> {
+    private readonly value;
+    constructor(value: T);
+    unwrap(): T;
+    isError(): this is ErrorEntry;
+}
+declare class ErrorEntry {
+    private readonly error;
+    constructor(error: unknown);
+    unwrap(): unknown;
+    isError(): this is ErrorEntry;
+}
+export declare class Cache<K extends object, V> {
+    private cache;
+    get(key: K): SuccessEntry<V> | ErrorEntry | undefined;
+    put<const T extends V>(key: K, value: T): T;
+    error<const T>(key: K, error: T): T;
+    clear(): void;
+}
+export {};

package/dist/plugins/cache.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Cache = void 0;
+class SuccessEntry {
+    value;
+    constructor(value) {
+        this.value = value;
+    }
+    unwrap() {
+        return this.value;
+    }
+    isError() {
+        return false;
+    }
+}
+class ErrorEntry {
+    error;
+    constructor(error) {
+        this.error = error;
+    }
+    unwrap() {
+        return this.error;
+    }
+    isError() {
+        return true;
+    }
+}
+class Cache {
+    cache = new WeakMap();
+    get(key) {
+        return this.cache.get(key);
+    }
+    put(key, value) {
+        this.cache.set(key, new SuccessEntry(value));
+        return value;
+    }
+    error(key, error) {
+        this.cache.set(key, new ErrorEntry(error));
+        return error;
+    }
+    clear() {
+        this.cache = new WeakMap();
+    }
+}
+exports.Cache = Cache;
+//# sourceMappingURL=cache.js.map

package/dist/plugins/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/plugins/cache.ts"],"names":[],"mappings":";;;AAAA,MAAM,YAAY;IACe;IAA7B,YAA6B,KAAQ;QAAR,UAAK,GAAL,KAAK,CAAG;IAAG,CAAC;IAEzC,MAAM;QACF,OAAO,IAAI,CAAC,KAAK,CAAA;IACrB,CAAC;IAED,OAAO;QACH,OAAO,KAAK,CAAA;IAChB,CAAC;CACJ;AAED,MAAM,UAAU;IACiB;IAA7B,YAA6B,KAAc;QAAd,UAAK,GAAL,KAAK,CAAS;IAAG,CAAC;IAE/C,MAAM;QACF,OAAO,IAAI,CAAC,KAAK,CAAA;IACrB,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAA;IACf,CAAC;CACJ;AAED,MAAa,KAAK;IACN,KAAK,GAAG,IAAI,OAAO,EAAE,CAAA;IAE7B,GAAG,CAAC,GAAM;QACN,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED,GAAG,CAAoB,GAAM,EAAE,KAAQ;QACnC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAA;QAC5C,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,KAAK,CAAU,GAAM,EAAE,KAAQ;QAC3B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAA;QAC1C,OAAO,KAAK,CAAA;IAChB,CAAC;IAED,KAAK;QACD,IAAI,CAAC,KAAK,GAAG,IAAI,OAAO,EAAE,CAAA;IAC9B,CAAC;CACJ;AApBD,sBAoBC"}

package/dist/plugins/context.d.ts

@@ -0,0 +1,85 @@
+import type { Compiler } from '../compiler';
+import type { Diagnostic } from '../diagnostic';
+import type { FileSystem } from '../fs';
+import type { Logger } from '../logger';
+import type { Package } from '../app';
+import type { ts } from '../typescript';
+import type { Plugin, Plugins, Result } from './plugin';
+import type { Product, Source } from './product';
+import type { Project } from './project';
+import type { Action, CoalesceKeys, ObjectShape, Record, RecordId, Shape, StringShape } from './shape';
+import type { File, InstallCategory } from './file';
+import type { Formatter } from '../formatter';
+import type { NowConfig } from '../now-config';
+import type { Database } from './database';
+export interface Keys {
+    queryExplicitId(table: string, key: string | number | Shape): string | undefined;
+    registerExplicitId(table: string, key: string | number | Shape, guidOverride?: string): string;
+    deleteExplicitId(table: string, key: string | number, guidOverride?: string): string;
+    queryCoalesceId(table: string, key: CoalesceKeys): string | undefined;
+    registerCoalesceId(table: string, key: CoalesceKeys, guidOverride?: string): string;
+    deleteCoalesceId(table: string, key: CoalesceKeys, guidOverride?: string): string;
+    getEffectiveDeletedKeys(): Now.Internal.AnyKey[];
+    getSourceFile(): ts.SourceFile;
+    getFilePath(): string;
+    getValue(): Now.Internal.KeysRegistry;
+    commit(formatter?: Formatter): Promise<void>;
+    reload(): void;
+}
+export interface Diagnostics {
+    error(source: Product | ts.Node, message: string): void;
+    warn(source: Product | ts.Node, message: string): void;
+    info(source: Product | ts.Node, message: string): void;
+    hint(source: Product | ts.Node, message: string): void;
+    add(diagnostic: Diagnostic): void;
+    getAll(file?: string): Diagnostic[];
+    clear(file?: string): void;
+    getWarnings(file?: string): Diagnostic[];
+    hasErrors(file?: string): boolean;
+    getErrors(file?: string): Diagnostic[];
+}
+export interface Transform {
+    toShape(node: ts.Node, ...plugins: Plugin[]): Promise<Result<Shape>>;
+    recordToShape(record: Record, database: Database, ...plugins: Plugin[]): Promise<Result<Shape>>;
+    toSubclass<const S extends Shape>(shape: S, ...plugins: Plugin[]): Result<S>;
+    toRecord(node: ts.Node, ...plugins: Plugin[]): Promise<Result<Record>>;
+    toRecord(shape: Shape, ...plugins: Plugin[]): Promise<Result<Record>>;
+    toRecord(file: File, ...plugins: Plugin[]): Promise<Result<Record>>;
+    toRecord(source: ts.Node | Shape | File, ...plugins: Plugin[]): Promise<Result<Record>>;
+}
+export interface Factory {
+    createShape<const S extends Shape>(shape: S): S;
+    createRecord(args: {
+        source: Source;
+        table: string;
+        explicitId?: string | Shape;
+        guidOverride?: string;
+        properties: NonNullable<object>;
+        action?: Action;
+        installCategory?: InstallCategory;
+    }): Record;
+    createReference(args: {
+        source: Source;
+        table: string | StringShape;
+        guid?: string | StringShape | undefined;
+        keys?: globalThis.Record<string, string | Shape> | ObjectShape | undefined;
+    }): RecordId;
+}
+export interface Parser {
+    parsePayload(file: File): Record[];
+}
+export type Context = {
+    readonly self: Plugin;
+    readonly fs: FileSystem;
+    readonly logger: Logger;
+    readonly packageJson: Package;
+    readonly config: NowConfig;
+    readonly project: Project;
+    readonly compiler: Compiler;
+    readonly plugins: Plugins;
+    readonly keys: Keys;
+    readonly diagnostics: Diagnostics;
+    readonly transform: Transform;
+    readonly factory: Factory;
+    readonly parser: Parser;
+};

package/dist/plugins/{Context.js → context.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Context.js.map
+//# sourceMappingURL=context.js.map

package/dist/plugins/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/plugins/context.ts"],"names":[],"mappings":""}

package/dist/plugins/database.d.ts

@@ -0,0 +1,27 @@
+import type { Record, RecordId } from './shape';
+type Query = {
+    [column: string]: unknown;
+};
+export declare class Database implements Iterable<Record> {
+    private readonly database;
+    constructor(records?: Record[]);
+    insert(...records: Record[]): void;
+    resolve(id: RecordId): Record | undefined;
+    get(table: string, guid: string): Record | undefined;
+    get(table: string, query: Query): Record | undefined;
+    query(table?: string, query?: Query): Record[];
+    compare(other: Database | Record[]): DiffDatabase;
+    [Symbol.iterator](): IterableIterator<Record>;
+}
+/**
+ * The initial set of records passed into the constructor is treated as the baseline. Any record
+ * inserted after that will be tracked as "changed" unless it is equal to its baseline counterpart.
+ * Useful for getting a diff/delta between two databases.
+ */
+export declare class DiffDatabase extends Database {
+    private readonly changedGuids;
+    constructor(records?: Record[]);
+    insert(...records: Record[]): void;
+    isChanged(record: Record): boolean;
+}
+export {};

package/dist/plugins/database.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DiffDatabase = exports.Database = void 0;
+class Database {
+    database = {};
+    constructor(records = []) {
+        this.insert(...records);
+    }
+    insert(...records) {
+        for (const record of records) {
+            const table = (this.database[record.getTable()] ??= {});
+            const guid = record.getId().getValue();
+            table[guid] = record;
+        }
+    }
+    resolve(id) {
+        const table = id.getTable();
+        const guid = id.getValue();
+        const record = this.database[table]?.[guid];
+        if (record) {
+            return record;
+        }
+        const keys = id.getKeys();
+        if (!keys) {
+            return undefined;
+        }
+        const matches = this.query(table, keys);
+        if (matches.length > 1) {
+            throw new Error(`Multiple records found for table "${table}" with coalesce keys: ${JSON.stringify(keys)}`);
+        }
+        return matches[0];
+    }
+    get(table, guidOrQuery) {
+        if (typeof guidOrQuery === 'string') {
+            return this.database[table]?.[guidOrQuery];
+        }
+        const [record, ...rest] = this.query(table, guidOrQuery);
+        if (rest.length > 0) {
+            throw new Error(`Expected get() to return no more than 1 match, but ${rest.length + 1} matches were found.`);
+        }
+        return record;
+    }
+    query(table, query = {}) {
+        if (!table) {
+            return Object.values(this.database).flatMap((table) => Object.values(table));
+        }
+        const records = [];
+        outer: for (const record of Object.values(this.database[table] ?? {})) {
+            for (const [column, value] of Object.entries(query)) {
+                if (!record.get(column).equals(value)) {
+                    continue outer;
+                }
+            }
+            records.push(record);
+        }
+        return records;
+    }
+    compare(other) {
+        const diff = new DiffDatabase(this.query());
+        diff.insert(...(other instanceof Database ? other.query() : other));
+        return diff;
+    }
+    [Symbol.iterator]() {
+        return this.query()[Symbol.iterator]();
+    }
+}
+exports.Database = Database;
+/**
+ * The initial set of records passed into the constructor is treated as the baseline. Any record
+ * inserted after that will be tracked as "changed" unless it is equal to its baseline counterpart.
+ * Useful for getting a diff/delta between two databases.
+ */
+class DiffDatabase extends Database {
+    changedGuids = [];
+    constructor(records = []) {
+        super(records);
+    }
+    insert(...records) {
+        if (!this.changedGuids) {
+            // This will happen when called from the super constructor
+            super.insert(...records);
+            return;
+        }
+        for (const record of records) {
+            const id = record.getId();
+            const existing = this.resolve(id);
+            if (existing && !existing.strictEquals(record)) {
+                this.changedGuids.push(id.getValue());
+                super.insert(existing.merge(record));
+            }
+            else if (!existing) {
+                this.changedGuids.push(id.getValue());
+                super.insert(record);
+            }
+        }
+    }
+    isChanged(record) {
+        return this.changedGuids.includes(record.getId().getValue());
+    }
+}
+exports.DiffDatabase = DiffDatabase;
+//# sourceMappingURL=database.js.map

package/dist/plugins/database.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.js","sourceRoot":"","sources":["../../src/plugins/database.ts"],"names":[],"mappings":";;;AAIA,MAAa,QAAQ;IACA,QAAQ,GAAoD,EAAE,CAAA;IAE/E,YAAY,UAAoB,EAAE;QAC9B,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,CAAA;IAC3B,CAAC;IAED,MAAM,CAAC,GAAG,OAAiB;QACvB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,CAAA;YACvD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAA;YACtC,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAA;QACxB,CAAC;IACL,CAAC;IAED,OAAO,CAAC,EAAY;QAChB,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAA;QAC3B,MAAM,IAAI,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAA;QAE1B,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;QAC3C,IAAI,MAAM,EAAE,CAAC;YACT,OAAO,MAAM,CAAA;QACjB,CAAC;QAED,MAAM,IAAI,GAAG,EAAE,CAAC,OAAO,EAAE,CAAA;QACzB,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO,SAAS,CAAA;QACpB,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QACvC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,qCAAqC,KAAK,yBAAyB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QAC9G,CAAC;QAED,OAAO,OAAO,CAAC,CAAC,CAAC,CAAA;IACrB,CAAC;IAGD,GAAG,CAAC,KAAa,EAAE,WAA2B;QAC1C,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,CAAA;QAC9C,CAAC;QAED,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QACxD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,sDAAsD,IAAI,CAAC,MAAM,GAAG,CAAC,sBAAsB,CAAC,CAAA;QAChH,CAAC;QAED,OAAO,MAAM,CAAA;IACjB,CAAC;IAED,KAAK,CAAC,KAAc,EAAE,QAAe,EAAE;QACnC,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;QAChF,CAAC;QAED,MAAM,OAAO,GAAa,EAAE,CAAA;QAC5B,KAAK,EAAE,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;YACpE,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;oBACpC,SAAS,KAAK,CAAA;gBAClB,CAAC;YACL,CAAC;YAED,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACxB,CAAC;QAED,OAAO,OAAO,CAAA;IAClB,CAAC;IAED,OAAO,CAAC,KAA0B;QAC9B,MAAM,IAAI,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;QAC3C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,YAAY,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;QACnE,OAAO,IAAI,CAAA;IACf,CAAC;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC;QACb,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAA;IAC1C,CAAC;CACJ;AA/ED,4BA+EC;AAED;;;;GAIG;AACH,MAAa,YAAa,SAAQ,QAAQ;IACrB,YAAY,GAAa,EAAE,CAAA;IAE5C,YAAY,UAAoB,EAAE;QAC9B,KAAK,CAAC,OAAO,CAAC,CAAA;IAClB,CAAC;IAEQ,MAAM,CAAC,GAAG,OAAiB;QAChC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACrB,0DAA0D;YAC1D,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,CAAA;YACxB,OAAM;QACV,CAAC;QAED,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,EAAE,CAAA;YACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YACjC,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC7C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;gBACrC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;YACxC,CAAC;iBAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACnB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;gBACrC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;YACxB,CAAC;QACL,CAAC;IACL,CAAC;IAED,SAAS,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;IAChE,CAAC;CACJ;AA9BD,oCA8BC"}

package/dist/plugins/file.d.ts

@@ -0,0 +1,10 @@
+export type File = {
+    path: string;
+    content: string;
+};
+export type InstallCategory = 'dictionary' | 'unload' | 'unload.demo' | 'update' | 'apply_once' | 'scope' | 'author_elective_update';
+export type OutputFile = {
+    name: string;
+    category: InstallCategory;
+    content: string;
+};

package/dist/plugins/{behaviors/Arranger.js → file.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Arranger.js.map
+//# sourceMappingURL=file.js.map

package/dist/plugins/file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/plugins/file.ts"],"names":[],"mappings":""}

package/dist/plugins/index.d.ts

@@ -1,5 +1,9 @@
-export { Plugin } from './Plugin';
-export { type Context, type HandledStates, type HandledInfo } from './Context';
-export * from './behaviors';
-export * from './util';
-export * from './Diagnostic';
+export * from './shape';
+export * from './file';
+export * from './context';
+export * from './plugin';
+export * from './product';
+export * from './project';
+export * from './database';
+export * from './time';
+export * from './usage';

package/dist/plugins/index.js

@@ -14,10 +14,13 @@ 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 });
-exports.Plugin = void 0;
-var Plugin_1 = require("./Plugin");
-Object.defineProperty(exports, "Plugin", { enumerable: true, get: function () { return Plugin_1.Plugin; } });
-__exportStar(require("./behaviors"), exports);
-__exportStar(require("./util"), exports);
-__exportStar(require("./Diagnostic"), exports);
+__exportStar(require("./shape"), exports);
+__exportStar(require("./file"), exports);
+__exportStar(require("./context"), exports);
+__exportStar(require("./plugin"), exports);
+__exportStar(require("./product"), exports);
+__exportStar(require("./project"), exports);
+__exportStar(require("./database"), exports);
+__exportStar(require("./time"), exports);
+__exportStar(require("./usage"), exports);
 //# sourceMappingURL=index.js.map

package/dist/plugins/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/plugins/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,mCAAiC;AAAxB,gGAAA,MAAM,OAAA;AAEf,8CAA2B;AAC3B,yCAAsB;AACtB,+CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/plugins/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,yCAAsB;AACtB,4CAAyB;AACzB,2CAAwB;AACxB,4CAAyB;AACzB,4CAAyB;AACzB,6CAA0B;AAC1B,yCAAsB;AACtB,0CAAuB"}