@salesforce/ts-types 2.0.9 → 2.0.11

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2023, Salesforce.com, Inc.
+Copyright (c) 2024, Salesforce.com, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

package/lib/errors.js

@@ -12,6 +12,7 @@ exports.JsonCloneError = exports.UnexpectedValueTypeError = exports.AssertionFai
  * For a complete `NamedError` solution, see [@salesforce/kit]{@link https://preview.npmjs.com/package/@salesforce/kit}.
  */
 class NamedError extends Error {
+    name;
     constructor(name, message) {
         super(message);
         this.name = name;

package/lib/experimental/index.js

@@ -6,7 +6,9 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasNull = exports.as = exports.is = void 0;
+exports.is = is;
+exports.as = as;
+exports.hasNull = hasNull;
 /**
  * A staging area for either introducing or removing type and functions, incrementally.
  */
@@ -25,7 +27,6 @@ function is(obj, shape) {
             .every(({ key, type, optional }) => (optional && !(key in obj)) ||
             ((0, narrowing_1.isString)(type) ? typeof (0, narrowing_1.get)(obj, key) === type : (0, narrowing_1.get)(obj, key) instanceof type)));
 }
-exports.is = is;
 /**
  * @ignore
  */
@@ -36,12 +37,10 @@ exports.is = is;
 function as(obj, shape) {
     return is(obj, shape) ? obj : undefined;
 }
-exports.as = as;
 /**
  * @ignore
  */
 function hasNull(value, key) {
     return (0, narrowing_1.has)(value, key) && value[key] == null;
 }
-exports.hasNull = hasNull;
 //# sourceMappingURL=index.js.map

package/lib/narrowing/as.js

@@ -6,61 +6,60 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asJsonArray = exports.asJsonMap = exports.asFunction = exports.asArray = exports.asInstance = exports.asDictionary = exports.asPlainObject = exports.asObject = exports.asBoolean = exports.asNumber = exports.asString = void 0;
+exports.asString = asString;
+exports.asNumber = asNumber;
+exports.asBoolean = asBoolean;
+exports.asObject = asObject;
+exports.asPlainObject = asPlainObject;
+exports.asDictionary = asDictionary;
+exports.asInstance = asInstance;
+exports.asArray = asArray;
+exports.asFunction = asFunction;
+exports.asJsonMap = asJsonMap;
+exports.asJsonArray = asJsonArray;
 const is_1 = require("./is");
 // underlying function
 function asString(value, defaultValue) {
     return (0, is_1.isString)(value) ? value : defaultValue;
 }
-exports.asString = asString;
 // underlying function
 function asNumber(value, defaultValue) {
     return (0, is_1.isNumber)(value) ? value : defaultValue;
 }
-exports.asNumber = asNumber;
 // underlying function
 function asBoolean(value, defaultValue) {
     return (0, is_1.isBoolean)(value) ? value : defaultValue;
 }
-exports.asBoolean = asBoolean;
 // underlying function
 function asObject(value, defaultValue) {
     return (0, is_1.isObject)(value) ? value : defaultValue;
 }
-exports.asObject = asObject;
 // underlying function
 function asPlainObject(value, defaultValue) {
     return (0, is_1.isPlainObject)(value) ? value : defaultValue;
 }
-exports.asPlainObject = asPlainObject;
 // underlying function
 function asDictionary(value, defaultValue) {
     return (0, is_1.isDictionary)(value) ? value : defaultValue;
 }
-exports.asDictionary = asDictionary;
 // underlying function
 function asInstance(value, ctor, defaultValue) {
     return (0, is_1.isInstance)(value, ctor) ? value : defaultValue;
 }
-exports.asInstance = asInstance;
 // underlying function
 function asArray(value, defaultValue) {
     return (0, is_1.isArray)(value) ? value : defaultValue;
 }
-exports.asArray = asArray;
 // underlying function
 function asFunction(value, defaultValue) {
     return (0, is_1.isFunction)(value) ? value : defaultValue;
 }
-exports.asFunction = asFunction;
 // underlying function
 function asJsonMap(value, defaultValue) {
     return (0, is_1.isJsonMap)(value) ? value : defaultValue;
 }
-exports.asJsonMap = asJsonMap;
 // underlying function
 function asJsonArray(value, defaultValue) {
     return (0, is_1.isJsonArray)(value) ? value : defaultValue;
 }
-exports.asJsonArray = asJsonArray;
 //# sourceMappingURL=as.js.map

package/lib/narrowing/assert.js

@@ -6,7 +6,20 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertJsonArray = exports.assertJsonMap = exports.assertAnyJson = exports.assertFunction = exports.assertArray = exports.assertInstance = exports.assertDictionary = exports.assertPlainObject = exports.assertObject = exports.assertBoolean = exports.assertNumber = exports.assertString = exports.assertNonNull = exports.assert = void 0;
+exports.assert = assert;
+exports.assertNonNull = assertNonNull;
+exports.assertString = assertString;
+exports.assertNumber = assertNumber;
+exports.assertBoolean = assertBoolean;
+exports.assertObject = assertObject;
+exports.assertPlainObject = assertPlainObject;
+exports.assertDictionary = assertDictionary;
+exports.assertInstance = assertInstance;
+exports.assertArray = assertArray;
+exports.assertFunction = assertFunction;
+exports.assertAnyJson = assertAnyJson;
+exports.assertJsonMap = assertJsonMap;
+exports.assertJsonArray = assertJsonArray;
 const errors_1 = require("../errors");
 const as_1 = require("./as");
 const to_1 = require("./to");
@@ -22,7 +35,6 @@ function assert(condition, message) {
         throw new errors_1.AssertionFailedError(message ?? 'Assertion condition was false');
     }
 }
-exports.assert = assert;
 /**
  * Narrows a type `Nullable<T>` to a `T` or raises an error.
  *
@@ -41,7 +53,6 @@ exports.assert = assert;
 function assertNonNull(value, message) {
     assert(value != null, message ?? 'Value is not defined');
 }
-exports.assertNonNull = assertNonNull;
 /**
  * Narrows an `unknown` value to a `string` if it is type-compatible, or raises an error otherwise.
  *
@@ -52,7 +63,6 @@ exports.assertNonNull = assertNonNull;
 function assertString(value, message) {
     assertNonNull((0, as_1.asString)(value), message ?? 'Value is not a string');
 }
-exports.assertString = assertString;
 /**
  * Narrows an `unknown` value to a `number` if it is type-compatible, or raises an error otherwise.
  *
@@ -63,7 +73,6 @@ exports.assertString = assertString;
 function assertNumber(value, message) {
     assertNonNull((0, as_1.asNumber)(value), message ?? 'Value is not a number');
 }
-exports.assertNumber = assertNumber;
 /**
  * Narrows an `unknown` value to a `boolean` if it is type-compatible, or raises an error otherwise.
  *
@@ -74,7 +83,6 @@ exports.assertNumber = assertNumber;
 function assertBoolean(value, message) {
     assertNonNull((0, as_1.asBoolean)(value), message ?? 'Value is not a boolean');
 }
-exports.assertBoolean = assertBoolean;
 /**
  * Narrows an `unknown` value to an `object` if it is type-compatible, or raises an error otherwise.
  *
@@ -85,7 +93,6 @@ exports.assertBoolean = assertBoolean;
 function assertObject(value, message) {
     assertNonNull((0, as_1.asObject)(value), message ?? 'Value is not an object');
 }
-exports.assertObject = assertObject;
 /**
  * Narrows an `unknown` value to an `object` if it is type-compatible and tests positively with {@link isPlainObject},
  * or raises an error otherwise.
@@ -97,7 +104,6 @@ exports.assertObject = assertObject;
 function assertPlainObject(value, message) {
     assertNonNull((0, as_1.asPlainObject)(value), message ?? 'Value is not a plain object');
 }
-exports.assertPlainObject = assertPlainObject;
 /**
  * Narrows an `unknown` value to a `Dictionary<T>` if it is type-compatible and tests positively
  * with {@link isDictionary}, or raises an error otherwise.
@@ -109,7 +115,6 @@ exports.assertPlainObject = assertPlainObject;
 function assertDictionary(value, message) {
     assertNonNull((0, as_1.asDictionary)(value), message ?? 'Value is not a dictionary object');
 }
-exports.assertDictionary = assertDictionary;
 /**
  * Narrows an `unknown` value to instance of constructor type `T` if it is type-compatible, or raises an error
  * otherwise.
@@ -121,7 +126,6 @@ exports.assertDictionary = assertDictionary;
 function assertInstance(value, ctor, message) {
     assertNonNull((0, as_1.asInstance)(value, ctor), message ?? `Value is not an instance of ${ctor.name}`);
 }
-exports.assertInstance = assertInstance;
 /**
  * Narrows an `unknown` value to an `Array` if it is type-compatible, or raises an error otherwise.
  *
@@ -132,7 +136,6 @@ exports.assertInstance = assertInstance;
 function assertArray(value, message) {
     assertNonNull((0, as_1.asArray)(value), message ?? 'Value is not an array');
 }
-exports.assertArray = assertArray;
 /**
  * Narrows an `unknown` value to an `AnyFunction` if it is type-compatible, or raises an error otherwise.
  *
@@ -143,7 +146,6 @@ exports.assertArray = assertArray;
 function assertFunction(value, message) {
     assertNonNull((0, as_1.asFunction)(value), message ?? 'Value is not a function');
 }
-exports.assertFunction = assertFunction;
 /**
  * Narrows an `unknown` value to an `AnyJson` if it is type-compatible, or returns `undefined` otherwise.
  *
@@ -156,7 +158,6 @@ exports.assertFunction = assertFunction;
 function assertAnyJson(value, message) {
     assertNonNull((0, to_1.toAnyJson)(value), message ?? 'Value is not a JSON-compatible value type');
 }
-exports.assertAnyJson = assertAnyJson;
 /**
  * Narrows an `AnyJson` value to a `JsonMap` if it is type-compatible, or raises an error otherwise.
  *
@@ -167,7 +168,6 @@ exports.assertAnyJson = assertAnyJson;
 function assertJsonMap(value, message) {
     assertNonNull((0, as_1.asJsonMap)(value), message ?? 'Value is not a JsonMap');
 }
-exports.assertJsonMap = assertJsonMap;
 /**
  * Narrows an `AnyJson` value to a `JsonArray` if it is type-compatible, or raises an error otherwise.
  *
@@ -178,5 +178,4 @@ exports.assertJsonMap = assertJsonMap;
 function assertJsonArray(value, message) {
     assertNonNull((0, as_1.asJsonArray)(value), message ?? 'Value is not a JsonArray');
 }
-exports.assertJsonArray = assertJsonArray;
 //# sourceMappingURL=assert.js.map

package/lib/narrowing/coerce.js

@@ -6,22 +6,21 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.coerceJsonArray = exports.coerceJsonMap = exports.coerceAnyJson = void 0;
+exports.coerceAnyJson = coerceAnyJson;
+exports.coerceJsonMap = coerceJsonMap;
+exports.coerceJsonArray = coerceJsonArray;
 const as_1 = require("./as");
 const is_1 = require("./is");
 // underlying function
 function coerceAnyJson(value, defaultValue) {
     return (0, is_1.isAnyJson)(value) ? value : defaultValue;
 }
-exports.coerceAnyJson = coerceAnyJson;
 // underlying function
 function coerceJsonMap(value, defaultValue) {
     return (0, as_1.asJsonMap)(coerceAnyJson(value)) ?? defaultValue;
 }
-exports.coerceJsonMap = coerceJsonMap;
 // underlying method
 function coerceJsonArray(value, defaultValue) {
     return (0, as_1.asJsonArray)(coerceAnyJson(value)) ?? defaultValue;
 }
-exports.coerceJsonArray = coerceJsonArray;
 //# sourceMappingURL=coerce.js.map

package/lib/narrowing/ensure.js

@@ -6,7 +6,19 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureJsonArray = exports.ensureJsonMap = exports.ensureAnyJson = exports.ensureFunction = exports.ensureArray = exports.ensureInstance = exports.ensureDictionary = exports.ensurePlainObject = exports.ensureObject = exports.ensureBoolean = exports.ensureNumber = exports.ensureString = exports.ensure = void 0;
+exports.ensure = ensure;
+exports.ensureString = ensureString;
+exports.ensureNumber = ensureNumber;
+exports.ensureBoolean = ensureBoolean;
+exports.ensureObject = ensureObject;
+exports.ensurePlainObject = ensurePlainObject;
+exports.ensureDictionary = ensureDictionary;
+exports.ensureInstance = ensureInstance;
+exports.ensureArray = ensureArray;
+exports.ensureFunction = ensureFunction;
+exports.ensureAnyJson = ensureAnyJson;
+exports.ensureJsonMap = ensureJsonMap;
+exports.ensureJsonArray = ensureJsonArray;
 const errors_1 = require("../errors");
 const as_1 = require("./as");
 const to_1 = require("./to");
@@ -31,7 +43,6 @@ function ensure(value, message) {
     }
     return value;
 }
-exports.ensure = ensure;
 /**
  * Narrows an `unknown` value to a `string` if it is type-compatible, or raises an error otherwise.
  *
@@ -42,7 +53,6 @@ exports.ensure = ensure;
 function ensureString(value, message) {
     return ensure((0, as_1.asString)(value), message ?? 'Value is not a string');
 }
-exports.ensureString = ensureString;
 /**
  * Narrows an `unknown` value to a `number` if it is type-compatible, or raises an error otherwise.
  *
@@ -53,7 +63,6 @@ exports.ensureString = ensureString;
 function ensureNumber(value, message) {
     return ensure((0, as_1.asNumber)(value), message ?? 'Value is not a number');
 }
-exports.ensureNumber = ensureNumber;
 /**
  * Narrows an `unknown` value to a `boolean` if it is type-compatible, or raises an error otherwise.
  *
@@ -64,7 +73,6 @@ exports.ensureNumber = ensureNumber;
 function ensureBoolean(value, message) {
     return ensure((0, as_1.asBoolean)(value), message ?? 'Value is not a boolean');
 }
-exports.ensureBoolean = ensureBoolean;
 /**
  * Narrows an `unknown` value to an `object` if it is type-compatible, or raises an error otherwise.
  *
@@ -75,7 +83,6 @@ exports.ensureBoolean = ensureBoolean;
 function ensureObject(value, message) {
     return ensure((0, as_1.asObject)(value), message ?? 'Value is not an object');
 }
-exports.ensureObject = ensureObject;
 /**
  * Narrows an `unknown` value to an `object` if it is type-compatible and tests positively with {@link isPlainObject},
  * or raises an error otherwise.
@@ -87,7 +94,6 @@ exports.ensureObject = ensureObject;
 function ensurePlainObject(value, message) {
     return ensure((0, as_1.asPlainObject)(value), message ?? 'Value is not a plain object');
 }
-exports.ensurePlainObject = ensurePlainObject;
 /**
  * Narrows an `unknown` value to a `Dictionary<T>` if it is type-compatible and tests positively
  * with {@link isDictionary}, or raises an error otherwise.
@@ -99,7 +105,6 @@ exports.ensurePlainObject = ensurePlainObject;
 function ensureDictionary(value, message) {
     return ensure((0, as_1.asDictionary)(value), message ?? 'Value is not a dictionary object');
 }
-exports.ensureDictionary = ensureDictionary;
 /**
  * Narrows an `unknown` value to instance of constructor type `T` if it is type-compatible, or raises an error
  * otherwise.
@@ -111,7 +116,6 @@ exports.ensureDictionary = ensureDictionary;
 function ensureInstance(value, ctor, message) {
     return ensure((0, as_1.asInstance)(value, ctor), message ?? `Value is not an instance of ${ctor.name}`);
 }
-exports.ensureInstance = ensureInstance;
 /**
  * Narrows an `unknown` value to an `Array` if it is type-compatible, or raises an error otherwise.
  *
@@ -122,7 +126,6 @@ exports.ensureInstance = ensureInstance;
 function ensureArray(value, message) {
     return ensure((0, as_1.asArray)(value), message ?? 'Value is not an array');
 }
-exports.ensureArray = ensureArray;
 /**
  * Narrows an `unknown` value to an `AnyFunction` if it is type-compatible, or raises an error otherwise.
  *
@@ -133,7 +136,6 @@ exports.ensureArray = ensureArray;
 function ensureFunction(value, message) {
     return ensure((0, as_1.asFunction)(value), message ?? 'Value is not a function');
 }
-exports.ensureFunction = ensureFunction;
 /**
  * Narrows an `unknown` value to an `AnyJson` if it is type-compatible, or returns `undefined` otherwise.
  *
@@ -146,7 +148,6 @@ exports.ensureFunction = ensureFunction;
 function ensureAnyJson(value, message) {
     return ensure((0, to_1.toAnyJson)(value), message ?? 'Value is not a JSON-compatible value type');
 }
-exports.ensureAnyJson = ensureAnyJson;
 /**
  * Narrows an `AnyJson` value to a `JsonMap` if it is type-compatible, or raises an error otherwise.
  *
@@ -157,7 +158,6 @@ exports.ensureAnyJson = ensureAnyJson;
 function ensureJsonMap(value, message) {
     return ensure((0, as_1.asJsonMap)(value), message ?? 'Value is not a JsonMap');
 }
-exports.ensureJsonMap = ensureJsonMap;
 /**
  * Narrows an `AnyJson` value to a `JsonArray` if it is type-compatible, or raises an error otherwise.
  *
@@ -168,5 +168,4 @@ exports.ensureJsonMap = ensureJsonMap;
 function ensureJsonArray(value, message) {
     return ensure((0, as_1.asJsonArray)(value), message ?? 'Value is not a JsonArray');
 }
-exports.ensureJsonArray = ensureJsonArray;
 //# sourceMappingURL=ensure.js.map

package/lib/narrowing/get.js

@@ -6,7 +6,19 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getJsonArray = exports.getJsonMap = exports.getAnyJson = exports.getFunction = exports.getArray = exports.getInstance = exports.getDictionary = exports.getPlainObject = exports.getObject = exports.getBoolean = exports.getNumber = exports.getString = exports.get = void 0;
+exports.get = get;
+exports.getString = getString;
+exports.getNumber = getNumber;
+exports.getBoolean = getBoolean;
+exports.getObject = getObject;
+exports.getPlainObject = getPlainObject;
+exports.getDictionary = getDictionary;
+exports.getInstance = getInstance;
+exports.getArray = getArray;
+exports.getFunction = getFunction;
+exports.getAnyJson = getAnyJson;
+exports.getJsonMap = getJsonMap;
+exports.getJsonArray = getJsonArray;
 const as_1 = require("./as");
 const coerce_1 = require("./coerce");
 const has_1 = require("./has");
@@ -43,65 +55,52 @@ function get(from, path, defaultValue) {
         .filter((p) => !!p)
         .reduce((r, p) => ((0, has_1.has)(r, p) ? r[p] : undefined), from), defaultValue);
 }
-exports.get = get;
 // underlying function
 function getString(from, path, defaultValue) {
     return (0, internal_1.valueOrDefault)((0, as_1.asString)(get(from, path)), defaultValue);
 }
-exports.getString = getString;
 // underlying function
 function getNumber(from, path, defaultValue) {
     return (0, internal_1.valueOrDefault)((0, as_1.asNumber)(get(from, path)), defaultValue);
 }
-exports.getNumber = getNumber;
 // underlying function
 function getBoolean(from, path, defaultValue) {
     return (0, internal_1.valueOrDefault)((0, as_1.asBoolean)(get(from, path)), defaultValue);
 }
-exports.getBoolean = getBoolean;
 // underlying function
 function getObject(from, path, defaultValue) {
     return (0, internal_1.valueOrDefault)((0, as_1.asObject)(get(from, path)), defaultValue);
 }
-exports.getObject = getObject;
 // underlying function
 function getPlainObject(from, path, defaultValue) {
     return (0, internal_1.valueOrDefault)((0, as_1.asPlainObject)(get(from, path)), defaultValue);
 }
-exports.getPlainObject = getPlainObject;
 // underlying function
 function getDictionary(from, path, defaultValue) {
     return (0, internal_1.valueOrDefault)((0, as_1.asDictionary)(get(from, path)), defaultValue);
 }
-exports.getDictionary = getDictionary;
 // underlying function
 function getInstance(from, path, ctor, defaultValue) {
     return (0, internal_1.valueOrDefault)((0, as_1.asInstance)(get(from, path), ctor), defaultValue);
 }
-exports.getInstance = getInstance;
 // underlying function
 function getArray(from, path, defaultValue) {
     return (0, internal_1.valueOrDefault)((0, as_1.asArray)(get(from, path)), defaultValue);
 }
-exports.getArray = getArray;
 // underlying function
 function getFunction(from, path, defaultValue) {
     return (0, internal_1.valueOrDefault)((0, as_1.asFunction)(get(from, path)), defaultValue);
 }
-exports.getFunction = getFunction;
 // underlying function
 function getAnyJson(from, path, defaultValue) {
     return (0, internal_1.valueOrDefault)((0, coerce_1.coerceAnyJson)(get(from, path)), defaultValue);
 }
-exports.getAnyJson = getAnyJson;
 // underlying function
 function getJsonMap(from, path, defaultValue) {
     return (0, internal_1.valueOrDefault)((0, as_1.asJsonMap)(getAnyJson(from, path)), defaultValue);
 }
-exports.getJsonMap = getJsonMap;
 // underlying function
 function getJsonArray(from, path, defaultValue) {
     return (0, internal_1.valueOrDefault)((0, as_1.asJsonArray)(getAnyJson(from, path)), defaultValue);
 }
-exports.getJsonArray = getJsonArray;
 //# sourceMappingURL=get.js.map

package/lib/narrowing/has.js

@@ -6,7 +6,19 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasJsonArray = exports.hasJsonMap = exports.hasAnyJson = exports.hasFunction = exports.hasArray = exports.hasInstance = exports.hasDictionary = exports.hasPlainObject = exports.hasObject = exports.hasBoolean = exports.hasNumber = exports.hasString = exports.has = void 0;
+exports.has = has;
+exports.hasString = hasString;
+exports.hasNumber = hasNumber;
+exports.hasBoolean = hasBoolean;
+exports.hasObject = hasObject;
+exports.hasPlainObject = hasPlainObject;
+exports.hasDictionary = hasDictionary;
+exports.hasInstance = hasInstance;
+exports.hasArray = hasArray;
+exports.hasFunction = hasFunction;
+exports.hasAnyJson = hasAnyJson;
+exports.hasJsonMap = hasJsonMap;
+exports.hasJsonArray = hasJsonArray;
 const is_1 = require("./is");
 /**
  * Tests whether a value of type `T` contains one or more property `keys`. If so, the type of the tested value is
@@ -32,7 +44,6 @@ const is_1 = require("./is");
 function has(value, keys) {
     return (0, is_1.isObject)(value) && ((0, is_1.isArray)(keys) ? keys.every((k) => k in value) : keys in value);
 }
-exports.has = has;
 /**
  * Tests whether a value of type `T` contains a property `key` of type `string`. If so, the type of the tested value is
  * narrowed to reflect the existence of that key for convenient access in the same scope. Returns `false` if the
@@ -54,7 +65,6 @@ exports.has = has;
 function hasString(value, key) {
     return has(value, key) && (0, is_1.isString)(value[key]);
 }
-exports.hasString = hasString;
 /**
  * Tests whether a value of type `T` contains a property `key` of type `number`. If so, the type of the tested value is
  * narrowed to reflect the existence of that key for convenient access in the same scope. Returns `false` if the
@@ -76,7 +86,6 @@ exports.hasString = hasString;
 function hasNumber(value, key) {
     return has(value, key) && (0, is_1.isNumber)(value[key]);
 }
-exports.hasNumber = hasNumber;
 /**
  * Tests whether a value of type `T` contains a property `key` of type `boolean`. If so, the type of the tested value is
  * narrowed to reflect the existence of that key for convenient access in the same scope. Returns `false` if the
@@ -98,7 +107,6 @@ exports.hasNumber = hasNumber;
 function hasBoolean(value, key) {
     return has(value, key) && (0, is_1.isBoolean)(value[key]);
 }
-exports.hasBoolean = hasBoolean;
 /**
  * Tests whether a value of type `T` contains a property `key` of type `object`. If so, the type of the tested value is
  * narrowed to reflect the existence of that key for convenient access in the same scope. Returns `false` if the
@@ -122,7 +130,6 @@ exports.hasBoolean = hasBoolean;
 function hasObject(value, key) {
     return has(value, key) && (0, is_1.isObject)(value[key]);
 }
-exports.hasObject = hasObject;
 /**
  * Tests whether a value of type `T` contains a property `key` whose type tests positively when tested with
  * {@link isPlainObject}. If so, the type of the tested value is narrowed to reflect the existence of that key for
@@ -147,7 +154,6 @@ exports.hasObject = hasObject;
 function hasPlainObject(value, key) {
     return has(value, key) && (0, is_1.isPlainObject)(value[key]);
 }
-exports.hasPlainObject = hasPlainObject;
 /**
  * Tests whether a value of type `T` contains a property `key` whose type tests positively when tested with
  * {@link isDictionary}. If so, the type of the tested value is narrowed to reflect the existence of that key for
@@ -172,7 +178,6 @@ exports.hasPlainObject = hasPlainObject;
 function hasDictionary(value, key) {
     return has(value, key) && (0, is_1.isDictionary)(value[key]);
 }
-exports.hasDictionary = hasDictionary;
 /**
  * Tests whether a value of type `T` contains a property `key` whose type tests positively when tested with
  * {@link isInstance} when compared with the given constructor type `C`. If so, the type of the tested value is
@@ -198,7 +203,6 @@ exports.hasDictionary = hasDictionary;
 function hasInstance(value, key, ctor) {
     return has(value, key) && value[key] instanceof ctor;
 }
-exports.hasInstance = hasInstance;
 /**
  * Tests whether a value of type `T` contains a property `key` of type {@link AnyArray}. If so, the type of the tested
  * value is narrowed to reflect the existence of that key for convenient access in the same scope. Returns `false` if
@@ -220,7 +224,6 @@ exports.hasInstance = hasInstance;
 function hasArray(value, key) {
     return has(value, key) && (0, is_1.isArray)(value[key]);
 }
-exports.hasArray = hasArray;
 /**
  * Tests whether a value of type `T` contains a property `key` of type {@link AnyFunction}. If so, the type of the
  * tested value is narrowed to reflect the existence of that key for convenient access in the same scope. Returns
@@ -241,7 +244,6 @@ exports.hasArray = hasArray;
 function hasFunction(value, key) {
     return has(value, key) && (0, is_1.isFunction)(value[key]);
 }
-exports.hasFunction = hasFunction;
 /**
  * Tests whether a value of type `T` contains a property `key` of type {@link AnyJson}, _using a shallow test for
  * `AnyJson` compatibility_ (see {@link isAnyJson} for more information). If so, the type of the
@@ -262,7 +264,6 @@ exports.hasFunction = hasFunction;
 function hasAnyJson(value, key) {
     return has(value, key) && (0, is_1.isAnyJson)(value[key]);
 }
-exports.hasAnyJson = hasAnyJson;
 /**
  * Tests whether a value of type `T extends AnyJson` contains a property `key` of type {@link JsonMap}. If so, the type
  * of the tested value is narrowed to reflect the existence of that key for convenient access in the same scope. Returns
@@ -282,7 +283,6 @@ exports.hasAnyJson = hasAnyJson;
 function hasJsonMap(value, key) {
     return hasAnyJson(value, key) && (0, is_1.isJsonMap)(value[key]);
 }
-exports.hasJsonMap = hasJsonMap;
 /**
  * Tests whether a value of type `T extends AnyJson` contains a property `key` of type {@link JsonArray}. If so, the
  * type of the tested value is narrowed to reflect the existence of that key for convenient access in the same scope.
@@ -302,5 +302,4 @@ exports.hasJsonMap = hasJsonMap;
 function hasJsonArray(value, key) {
     return hasAnyJson(value, key) && (0, is_1.isJsonArray)(value[key]);
 }
-exports.hasJsonArray = hasJsonArray;
 //# sourceMappingURL=has.js.map

package/lib/narrowing/internal.js

@@ -6,7 +6,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.valueOrDefault = void 0;
+exports.valueOrDefault = valueOrDefault;
 /**
  * Returns the given `value` if not either `undefined` or `null`, or the given `defaultValue` otherwise if defined.
  * Returns `null` if the value is `null` and `defaultValue` is `undefined`.
@@ -18,5 +18,4 @@ exports.valueOrDefault = void 0;
 function valueOrDefault(value, defaultValue) {
     return value != null || defaultValue === undefined ? value : defaultValue;
 }
-exports.valueOrDefault = valueOrDefault;
 //# sourceMappingURL=internal.js.map

package/lib/narrowing/is.js

@@ -6,7 +6,21 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isKeyOf = exports.isJsonArray = exports.isJsonMap = exports.isAnyJson = exports.isArrayLike = exports.isArray = exports.isClassAssignableTo = exports.isInstance = exports.isDictionary = exports.isPlainObject = exports.isFunction = exports.isObject = exports.isBoolean = exports.isNumber = exports.isString = void 0;
+exports.isString = isString;
+exports.isNumber = isNumber;
+exports.isBoolean = isBoolean;
+exports.isObject = isObject;
+exports.isFunction = isFunction;
+exports.isPlainObject = isPlainObject;
+exports.isDictionary = isDictionary;
+exports.isInstance = isInstance;
+exports.isClassAssignableTo = isClassAssignableTo;
+exports.isArray = isArray;
+exports.isArrayLike = isArrayLike;
+exports.isAnyJson = isAnyJson;
+exports.isJsonMap = isJsonMap;
+exports.isJsonArray = isJsonArray;
+exports.isKeyOf = isKeyOf;
 /**
  * Tests whether an `unknown` value is a `string`.
  *
@@ -15,7 +29,6 @@ exports.isKeyOf = exports.isJsonArray = exports.isJsonMap = exports.isAnyJson =
 function isString(value) {
     return typeof value === 'string';
 }
-exports.isString = isString;
 /**
  * Tests whether an `unknown` value is a `number`.
  *
@@ -24,7 +37,6 @@ exports.isString = isString;
 function isNumber(value) {
     return typeof value === 'number';
 }
-exports.isNumber = isNumber;
 /**
  * Tests whether an `unknown` value is a `boolean`.
  *
@@ -33,7 +45,6 @@ exports.isNumber = isNumber;
 function isBoolean(value) {
     return typeof value === 'boolean';
 }
-exports.isBoolean = isBoolean;
 /**
  * Tests whether an `unknown` value is an `Object` subtype (e.g., arrays, functions, objects, regexes,
  * new Number(0), new String(''), and new Boolean(true)). Tests that wish to distinguish objects that
@@ -53,7 +64,6 @@ exports.isBoolean = isBoolean;
 function isObject(value) {
     return value != null && (typeof value === 'object' || typeof value === 'function');
 }
-exports.isObject = isObject;
 /**
  * Tests whether an `unknown` value is a `function`.
  *
@@ -62,7 +72,6 @@ exports.isObject = isObject;
 function isFunction(value) {
     return typeof value === 'function';
 }
-exports.isFunction = isFunction;
 /**
  * Tests whether or not an `unknown` value is a plain JavaScript object. That is, if it is an object created
  * by the Object constructor or one with a null `prototype`.
@@ -91,7 +100,6 @@ function isPlainObject(value) {
         return false;
     return true;
 }
-exports.isPlainObject = isPlainObject;
 /**
  * A shortcut for testing the suitability of a value to be used as a `Dictionary<T>` type.  Shorthand for
  * writing `isPlainObject<Dictionary<T>>(value)`.  While some non-plain-object types are compatible with
@@ -110,7 +118,6 @@ exports.isPlainObject = isPlainObject;
 function isDictionary(value) {
     return isPlainObject(value);
 }
-exports.isDictionary = isDictionary;
 /**
  * Tests whether an `unknown` value is a `function`.
  *
@@ -119,7 +126,6 @@ exports.isDictionary = isDictionary;
 function isInstance(value, ctor) {
     return value instanceof ctor;
 }
-exports.isInstance = isInstance;
 /**
  * Tests whether an `unknown` value is a class constructor that is either equal to or extends another class
  * constructor.
@@ -132,7 +138,6 @@ function isClassAssignableTo(value, cls) {
     const has = (v, k) => isObject(v) && k in v;
     return value === cls || (has(value, 'prototype') && value.prototype instanceof cls);
 }
-exports.isClassAssignableTo = isClassAssignableTo;
 /**
  * Tests whether an `unknown` value is an `Array`.
  *
@@ -149,7 +154,6 @@ exports.isClassAssignableTo = isClassAssignableTo;
 function isArray(value) {
     return Array.isArray(value);
 }
-exports.isArray = isArray;
 /**
  * Tests whether an `unknown` value conforms to {@link AnyArrayLike}.
  *
@@ -168,7 +172,6 @@ function isArrayLike(value) {
     const hasLength = (v) => isObject(v) && 'length' in v;
     return !isFunction(value) && (isString(value) || hasLength(value));
 }
-exports.isArrayLike = isArrayLike;
 /**
  * Tests whether `unknown` value is a valid JSON type. Note that objects and arrays are only checked using a shallow
  * test. To be sure that a given value is JSON-compatible at runtime, see {@link toAnyJson}.
@@ -178,7 +181,6 @@ exports.isArrayLike = isArrayLike;
 function isAnyJson(value) {
     return (value === null || isString(value) || isNumber(value) || isBoolean(value) || isPlainObject(value) || isArray(value));
 }
-exports.isAnyJson = isAnyJson;
 /**
  * Tests whether an `AnyJson` value is an object.
  *
@@ -187,7 +189,6 @@ exports.isAnyJson = isAnyJson;
 function isJsonMap(value) {
     return isPlainObject(value);
 }
-exports.isJsonMap = isJsonMap;
 /**
  * Tests whether an `AnyJson` value is an array.
  *
@@ -196,7 +197,6 @@ exports.isJsonMap = isJsonMap;
 function isJsonArray(value) {
     return isArray(value);
 }
-exports.isJsonArray = isJsonArray;
 /**
  * Tests whether or not a `key` string is a key of the given object type `T`.
  *
@@ -206,5 +206,4 @@ exports.isJsonArray = isJsonArray;
 function isKeyOf(obj, key) {
     return Object.keys(obj).includes(key);
 }
-exports.isKeyOf = isKeyOf;
 //# sourceMappingURL=is.js.map

package/lib/narrowing/object.js

@@ -6,7 +6,12 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.definiteValuesOf = exports.definiteKeysOf = exports.definiteEntriesOf = exports.valuesOf = exports.entriesOf = exports.keysOf = void 0;
+exports.keysOf = keysOf;
+exports.entriesOf = entriesOf;
+exports.valuesOf = valuesOf;
+exports.definiteEntriesOf = definiteEntriesOf;
+exports.definiteKeysOf = definiteKeysOf;
+exports.definiteValuesOf = definiteValuesOf;
 /**
  * Returns the keys of an object of type `T`. This is like `Object.keys` except the return type
  * captures the known keys of `T`.
@@ -38,7 +43,6 @@ exports.definiteValuesOf = exports.definiteKeysOf = exports.definiteEntriesOf =
 function keysOf(obj) {
     return Object.keys(obj ?? {});
 }
-exports.keysOf = keysOf;
 /**
  * Returns the entries of an object of type `T`. This is like `Object.entries` except the return type
  * captures the known keys and value types of `T`.
@@ -70,7 +74,6 @@ exports.keysOf = keysOf;
 function entriesOf(obj) {
     return Object.entries(obj ?? {});
 }
-exports.entriesOf = entriesOf;
 /**
  * Returns the values of an object of type `T`. This is like `Object.values` except the return type
  * captures the possible value types of `T`.
@@ -102,7 +105,6 @@ exports.entriesOf = entriesOf;
 function valuesOf(obj) {
     return Object.values(obj ?? {});
 }
-exports.valuesOf = valuesOf;
 /**
  * Returns an array of all entry tuples of type `[K, NonNullable<T[K]>]` in an object `T` whose values are neither
  * `null` nor `undefined`. This can be convenient for enumerating the entries of unknown objects with optional
@@ -116,7 +118,6 @@ exports.valuesOf = valuesOf;
 function definiteEntriesOf(obj) {
     return entriesOf(obj).filter((entry) => entry[1] != null);
 }
-exports.definiteEntriesOf = definiteEntriesOf;
 /**
  * Returns an array of all `string` keys in an object of type `T` whose values are neither `null` nor `undefined`.
  * This can be convenient for enumerating the keys of definitely assigned properties in an object or `Dictionary`.
@@ -128,7 +129,6 @@ exports.definiteEntriesOf = definiteEntriesOf;
 function definiteKeysOf(obj) {
     return definiteEntriesOf(obj).map((entry) => entry[0]);
 }
-exports.definiteKeysOf = definiteKeysOf;
 /**
  * Returns an array of all values of type `T` in an object `T` for values that are neither `null` nor `undefined`.
  * This can be convenient for enumerating the values of unknown objects with optional properties (including
@@ -139,5 +139,4 @@ exports.definiteKeysOf = definiteKeysOf;
 function definiteValuesOf(obj) {
     return definiteEntriesOf(obj).map((entry) => entry[1]);
 }
-exports.definiteValuesOf = definiteValuesOf;
 //# sourceMappingURL=object.js.map

package/lib/narrowing/to.js

@@ -6,7 +6,9 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toJsonArray = exports.toJsonMap = exports.toAnyJson = void 0;
+exports.toAnyJson = toAnyJson;
+exports.toJsonMap = toJsonMap;
+exports.toJsonArray = toJsonArray;
 const errors_1 = require("../errors");
 const as_1 = require("./as");
 // underlying function
@@ -18,15 +20,12 @@ function toAnyJson(value, defaultValue) {
         throw new errors_1.JsonCloneError(err);
     }
 }
-exports.toAnyJson = toAnyJson;
 // underlying function
 function toJsonMap(value, defaultValue) {
     return (0, as_1.asJsonMap)(toAnyJson(value)) ?? defaultValue;
 }
-exports.toJsonMap = toJsonMap;
 // underlying method
 function toJsonArray(value, defaultValue) {
     return (0, as_1.asJsonArray)(toAnyJson(value)) ?? defaultValue;
 }
-exports.toJsonArray = toJsonArray;
 //# sourceMappingURL=to.js.map

package/lib/types/collection.d.ts

@@ -8,17 +8,15 @@ import { Optional } from './union';
  * and values, see the following functions: {@link definiteEntriesOf}, {@link definiteKeysOf}, and
  * {@link definiteValuesOf}.
  */
-export interface Dictionary<T = unknown> {
+export type Dictionary<T = unknown> = {
     [key: string]: Optional<T>;
-}
+};
 /**
  * An alias for an array of `T` elements, where `T` defaults to `unknown`.
  */
-export interface AnyArray<T = unknown> extends Array<T> {
-}
+export type AnyArray<T = unknown> = T[];
 /**
  * Any object with both a numeric index signature with values of type `T` and a numeric `length`
  * property. `T` defaults to `unknown` if unspecified.
  */
-export interface AnyArrayLike<T = unknown> extends ArrayLike<T> {
-}
+export type AnyArrayLike<T = unknown> = ArrayLike<T>;

package/lib/types/json.d.ts

@@ -22,5 +22,4 @@ export interface JsonMap extends Dictionary<AnyJson> {
 /**
  * Any JSON-compatible array.
  */
-export interface JsonArray extends Array<AnyJson> {
-}
+export type JsonArray = AnyJson[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/ts-types",
-  "version": "2.0.9",
+  "version": "2.0.11",
   "description": "Types and related utilities for TypeScript",
   "main": "lib/index.js",
   "repository": "forcedotcom/ts-types",
@@ -8,7 +8,7 @@
   "license": "BSD-3-Clause",
   "types": "lib/index.d.ts",
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "lib/**/*.js",
@@ -16,46 +16,23 @@
   ],
   "scripts": {
     "build": "wireit",
-    "ci-docs": "yarn sf-ci-docs",
     "clean": "sf-clean",
     "clean-all": "sf-clean all",
     "compile": "wireit",
     "docs": "sf-docs",
     "format": "wireit",
+    "link-check": "wireit",
     "lint": "wireit",
     "prepack": "sf-prepack",
     "prepare": "sf-install",
     "test": "wireit",
     "test:only": "wireit"
   },
-  "dependencies": {
-    "tslib": "^2.6.2"
-  },
+  "dependencies": {},
   "devDependencies": {
-    "@salesforce/dev-config": "^4.0.1",
-    "@salesforce/dev-scripts": "^5.11.0",
-    "@salesforce/prettier-config": "^0.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
-    "chai": "^4.3.10",
-    "eslint": "^8.51.0",
-    "eslint-config-prettier": "^8.10.0",
-    "eslint-config-salesforce": "^2.0.2",
-    "eslint-config-salesforce-license": "^0.2.0",
-    "eslint-config-salesforce-typescript": "^1.1.2",
-    "eslint-plugin-header": "^3.1.1",
-    "eslint-plugin-import": "2.28.1",
-    "eslint-plugin-jsdoc": "^43.2.0",
-    "eslint-plugin-prefer-arrow": "^1.2.1",
-    "husky": "^7.0.4",
-    "mocha": "^9.1.3",
-    "nyc": "^15.1.0",
-    "prettier": "^2.8.8",
-    "pretty-quick": "^3.1.0",
-    "sinon": "10.0.0",
-    "ts-node": "^10.0.0",
-    "typescript": "^4.9.5",
-    "wireit": "^0.14.0"
+    "@salesforce/dev-scripts": "^10.2.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.4"
   },
   "wireit": {
     "build": {
@@ -110,7 +87,8 @@
     "test": {
       "dependencies": [
         "test:only",
-        "test:compile"
+        "test:compile",
+        "link-check"
       ]
     },
     "test:only": {
@@ -127,6 +105,15 @@
         ".nycrc"
       ],
       "output": []
+    },
+    "link-check": {
+      "command": "node -e \"process.exit(process.env.CI ? 0 : 1)\" || linkinator \"**/*.md\" --skip \"CHANGELOG.md|node_modules|test/|confluence.internal.salesforce.com|my.salesforce.com|%s\" --markdown --retry --directory-listing --verbosity error",
+      "files": [
+        "./*.md",
+        "./!(CHANGELOG).md",
+        "messages/**/*.md"
+      ],
+      "output": []
     }
   }
 }