@salesforce/ts-types 1.5.20 → 1.7.0

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2018, Salesforce.com, Inc.
+Copyright (c) 2022, 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/README.md

@@ -7,7 +7,7 @@ This is a simple TypeScript-oriented library developed for use in Salesforce Typ
 1. A collection of commonly desired types.
 1. A collection of type-narrowing convenience functions for writing concise type-guards.
 
-See the [API documentation](https://forcedotcom.github.io/sfdx-dev-packages/ts-types) for more details on each of the utilities that `ts-types` provides.
+See the [API documentation](https://forcedotcom.github.io/ts-types) for more details on each of the utilities that `ts-types` provides.
 
 ## Why did we create it?
 

package/lib/experimental/index.d.ts

@@ -1,4 +1,4 @@
-import { AnyArray, AnyConstructor, AnyFunction, Dictionary, Many, Nullable, Optional, View } from '../types';
+import { AnyConstructor, Dictionary, Nullable, Optional, View } from '../types';
 /**
  * @ignore
  */
@@ -26,51 +26,7 @@ export declare function is<T extends object>(obj: Nullable<object>, shape: Objec
  * @ignore
  */
 export declare function as<T extends object>(obj: Nullable<object>, shape: ObjectShape): Optional<T>;
-/**
- * A view over an `object` with constrainable, optional properties.
- *
- * @ignore
- */
-export declare type ViewOptional<K extends string, V = unknown> = {
-    [_ in K]?: V;
-};
 /**
  * @ignore
  */
 export declare function hasNull<T, K extends string>(value: T, key: K): value is T & View<K, string>;
-/**
- * @ignore
- */
-export declare function view<T, K extends string>(value: Nullable<T>, keys: Many<K>): Optional<T & ViewOptional<K>>;
-/**
- * @ignore
- */
-export declare function viewString<T, K extends string>(value: Nullable<T>, key: K): Optional<T & ViewOptional<K, string>>;
-/**
- * @ignore
- */
-export declare function viewNumber<T, K extends string>(value: Nullable<T>, key: K): Optional<T & ViewOptional<K, number>>;
-/**
- * @ignore
- */
-export declare function viewBoolean<T, K extends string>(value: Nullable<T>, key: K): Optional<T & ViewOptional<K, boolean>>;
-/**
- * @ignore
- */
-export declare function viewObject<T, K extends string>(value: Nullable<T>, key: K): Optional<T & ViewOptional<K, object>>;
-/**
- * @ignore
- */
-export declare function viewPlainObject<T, K extends string>(value: Nullable<T>, key: K): Optional<T & ViewOptional<K, object>>;
-/**
- * @ignore
- */
-export declare function viewInstance<T, K extends string, C extends AnyConstructor>(value: Nullable<T>, key: K, ctor: C): Optional<T & ViewOptional<K, InstanceType<C>>>;
-/**
- * @ignore
- */
-export declare function viewArray<T, K extends string>(value: Nullable<T>, key: K): Optional<T & ViewOptional<K, AnyArray>>;
-/**
- * @ignore
- */
-export declare function viewFunction<T, K extends string>(value: Nullable<T>, key: K): Optional<T & ViewOptional<K, AnyFunction>>;

package/lib/experimental/index.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.viewFunction = exports.viewArray = exports.viewInstance = exports.viewPlainObject = exports.viewObject = exports.viewBoolean = exports.viewNumber = exports.viewString = exports.view = exports.hasNull = exports.as = exports.is = void 0;
+exports.hasNull = exports.as = exports.is = void 0;
 /**
  * A staging area for either introducing or removing type and functions, incrementally.
  */
@@ -15,15 +15,15 @@ const narrowing_1 = require("../narrowing");
  * @ignore
  */
 function is(obj, shape) {
-    const isVerifiable = (v) => narrowing_1.isString(v) || narrowing_1.isFunction(v);
+    const isVerifiable = (v) => (0, narrowing_1.isString)(v) || (0, narrowing_1.isFunction)(v);
     return (!obj ||
-        narrowing_1.definiteEntriesOf(shape)
+        (0, narrowing_1.definiteEntriesOf)(shape)
             .map(([k, v]) => ({
             key: k,
             ...(isVerifiable(v) ? { type: v, optional: false } : v),
         }))
             .every(({ key, type, optional }) => (optional && !(key in obj)) ||
-            (narrowing_1.isString(type) ? typeof narrowing_1.get(obj, key) === type : narrowing_1.get(obj, key) instanceof type)));
+            ((0, narrowing_1.isString)(type) ? typeof (0, narrowing_1.get)(obj, key) === type : (0, narrowing_1.get)(obj, key) instanceof type)));
 }
 exports.is = is;
 /**
@@ -41,77 +41,7 @@ exports.as = as;
  * @ignore
  */
 function hasNull(value, key) {
-    return narrowing_1.has(value, key) && value[key] == null;
+    return (0, narrowing_1.has)(value, key) && value[key] == null;
 }
 exports.hasNull = hasNull;
-/**
- * @ignore
- */
-function view(value, keys) {
-    return narrowing_1.has(value, keys) ? value : undefined;
-}
-exports.view = view;
-/**
- * @ignore
- */
-function viewOptional(value, key, hasType) {
-    return hasType(value, key) ? value : hasNull(value, key) ? value : undefined;
-}
-/**
- * @ignore
- */
-function viewString(value, key) {
-    return viewOptional(value, key, narrowing_1.hasString);
-}
-exports.viewString = viewString;
-/**
- * @ignore
- */
-function viewNumber(value, key) {
-    return viewOptional(value, key, narrowing_1.hasNumber);
-}
-exports.viewNumber = viewNumber;
-/**
- * @ignore
- */
-function viewBoolean(value, key) {
-    return viewOptional(value, key, narrowing_1.hasBoolean);
-}
-exports.viewBoolean = viewBoolean;
-/**
- * @ignore
- */
-function viewObject(value, key) {
-    return viewOptional(value, key, narrowing_1.hasObject);
-}
-exports.viewObject = viewObject;
-/**
- * @ignore
- */
-function viewPlainObject(value, key) {
-    return viewOptional(value, key, narrowing_1.hasPlainObject);
-}
-exports.viewPlainObject = viewPlainObject;
-/**
- * @ignore
- */
-function viewInstance(value, key, ctor) {
-    const hasType = (v, k) => narrowing_1.hasInstance(v, k, ctor);
-    return viewOptional(value, key, hasType);
-}
-exports.viewInstance = viewInstance;
-/**
- * @ignore
- */
-function viewArray(value, key) {
-    return viewOptional(value, key, narrowing_1.hasArray);
-}
-exports.viewArray = viewArray;
-/**
- * @ignore
- */
-function viewFunction(value, key) {
-    return viewOptional(value, key, narrowing_1.hasFunction);
-}
-exports.viewFunction = viewFunction;
 //# sourceMappingURL=index.js.map

package/lib/index.js

@@ -7,7 +7,11 @@
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];

package/lib/narrowing/as.js

@@ -10,57 +10,57 @@ exports.asJsonArray = exports.asJsonMap = exports.asFunction = exports.asArray =
 const is_1 = require("./is");
 // underlying function
 function asString(value, defaultValue) {
-    return is_1.isString(value) ? value : defaultValue;
+    return (0, is_1.isString)(value) ? value : defaultValue;
 }
 exports.asString = asString;
 // underlying function
 function asNumber(value, defaultValue) {
-    return is_1.isNumber(value) ? value : defaultValue;
+    return (0, is_1.isNumber)(value) ? value : defaultValue;
 }
 exports.asNumber = asNumber;
 // underlying function
 function asBoolean(value, defaultValue) {
-    return is_1.isBoolean(value) ? value : defaultValue;
+    return (0, is_1.isBoolean)(value) ? value : defaultValue;
 }
 exports.asBoolean = asBoolean;
 // underlying function
 function asObject(value, defaultValue) {
-    return is_1.isObject(value) ? value : defaultValue;
+    return (0, is_1.isObject)(value) ? value : defaultValue;
 }
 exports.asObject = asObject;
 // underlying function
 function asPlainObject(value, defaultValue) {
-    return is_1.isPlainObject(value) ? value : defaultValue;
+    return (0, is_1.isPlainObject)(value) ? value : defaultValue;
 }
 exports.asPlainObject = asPlainObject;
 // underlying function
 function asDictionary(value, defaultValue) {
-    return is_1.isDictionary(value) ? value : defaultValue;
+    return (0, is_1.isDictionary)(value) ? value : defaultValue;
 }
 exports.asDictionary = asDictionary;
 // underlying function
 function asInstance(value, ctor, defaultValue) {
-    return is_1.isInstance(value, ctor) ? value : defaultValue;
+    return (0, is_1.isInstance)(value, ctor) ? value : defaultValue;
 }
 exports.asInstance = asInstance;
 // underlying function
 function asArray(value, defaultValue) {
-    return is_1.isArray(value) ? value : defaultValue;
+    return (0, is_1.isArray)(value) ? value : defaultValue;
 }
 exports.asArray = asArray;
 // underlying function
 function asFunction(value, defaultValue) {
-    return is_1.isFunction(value) ? value : defaultValue;
+    return (0, is_1.isFunction)(value) ? value : defaultValue;
 }
 exports.asFunction = asFunction;
 // underlying function
 function asJsonMap(value, defaultValue) {
-    return is_1.isJsonMap(value) ? value : defaultValue;
+    return (0, is_1.isJsonMap)(value) ? value : defaultValue;
 }
 exports.asJsonMap = asJsonMap;
 // underlying function
 function asJsonArray(value, defaultValue) {
-    return is_1.isJsonArray(value) ? value : defaultValue;
+    return (0, is_1.isJsonArray)(value) ? value : defaultValue;
 }
 exports.asJsonArray = asJsonArray;
 //# sourceMappingURL=as.js.map

package/lib/narrowing/assert.js

@@ -19,7 +19,7 @@ const to_1 = require("./to");
  */
 function assert(condition, message) {
     if (!condition) {
-        throw new errors_1.AssertionFailedError(message || 'Assertion condition was false');
+        throw new errors_1.AssertionFailedError(message ?? 'Assertion condition was false');
     }
 }
 exports.assert = assert;
@@ -39,7 +39,7 @@ exports.assert = assert;
  * @throws {@link AssertionFailedError} If the value was undefined.
  */
 function assertNonNull(value, message) {
-    assert(value != null, message || 'Value is not defined');
+    assert(value != null, message ?? 'Value is not defined');
 }
 exports.assertNonNull = assertNonNull;
 /**
@@ -50,7 +50,7 @@ exports.assertNonNull = assertNonNull;
  * @throws {@link AssertionFailedError} If the value was undefined.
  */
 function assertString(value, message) {
-    assertNonNull(as_1.asString(value), message || 'Value is not a string');
+    assertNonNull((0, as_1.asString)(value), message ?? 'Value is not a string');
 }
 exports.assertString = assertString;
 /**
@@ -61,7 +61,7 @@ exports.assertString = assertString;
  * @throws {@link AssertionFailedError} If the value was undefined.
  */
 function assertNumber(value, message) {
-    assertNonNull(as_1.asNumber(value), message || 'Value is not a number');
+    assertNonNull((0, as_1.asNumber)(value), message ?? 'Value is not a number');
 }
 exports.assertNumber = assertNumber;
 /**
@@ -72,7 +72,7 @@ exports.assertNumber = assertNumber;
  * @throws {@link AssertionFailedError} If the value was undefined.
  */
 function assertBoolean(value, message) {
-    assertNonNull(as_1.asBoolean(value), message || 'Value is not a boolean');
+    assertNonNull((0, as_1.asBoolean)(value), message ?? 'Value is not a boolean');
 }
 exports.assertBoolean = assertBoolean;
 /**
@@ -83,7 +83,7 @@ exports.assertBoolean = assertBoolean;
  * @throws {@link AssertionFailedError} If the value was undefined.
  */
 function assertObject(value, message) {
-    assertNonNull(as_1.asObject(value), message || 'Value is not an object');
+    assertNonNull((0, as_1.asObject)(value), message ?? 'Value is not an object');
 }
 exports.assertObject = assertObject;
 /**
@@ -95,7 +95,7 @@ exports.assertObject = assertObject;
  * @throws {@link AssertionFailedError} If the value was undefined.
  */
 function assertPlainObject(value, message) {
-    assertNonNull(as_1.asPlainObject(value), message || 'Value is not a plain object');
+    assertNonNull((0, as_1.asPlainObject)(value), message ?? 'Value is not a plain object');
 }
 exports.assertPlainObject = assertPlainObject;
 /**
@@ -107,7 +107,7 @@ exports.assertPlainObject = assertPlainObject;
  * @throws {@link AssertionFailedError} If the value was undefined.
  */
 function assertDictionary(value, message) {
-    assertNonNull(as_1.asDictionary(value), message || 'Value is not a dictionary object');
+    assertNonNull((0, as_1.asDictionary)(value), message ?? 'Value is not a dictionary object');
 }
 exports.assertDictionary = assertDictionary;
 /**
@@ -119,7 +119,7 @@ exports.assertDictionary = assertDictionary;
  * @throws {@link AssertionFailedError} If the value was undefined.
  */
 function assertInstance(value, ctor, message) {
-    assertNonNull(as_1.asInstance(value, ctor), message || `Value is not an instance of ${ctor.name}`);
+    assertNonNull((0, as_1.asInstance)(value, ctor), message ?? `Value is not an instance of ${ctor.name}`);
 }
 exports.assertInstance = assertInstance;
 /**
@@ -130,7 +130,7 @@ exports.assertInstance = assertInstance;
  * @throws {@link AssertionFailedError} If the value was undefined.
  */
 function assertArray(value, message) {
-    assertNonNull(as_1.asArray(value), message || 'Value is not an array');
+    assertNonNull((0, as_1.asArray)(value), message ?? 'Value is not an array');
 }
 exports.assertArray = assertArray;
 /**
@@ -141,7 +141,7 @@ exports.assertArray = assertArray;
  * @throws {@link AssertionFailedError} If the value was undefined.
  */
 function assertFunction(value, message) {
-    assertNonNull(as_1.asFunction(value), message || 'Value is not a function');
+    assertNonNull((0, as_1.asFunction)(value), message ?? 'Value is not a function');
 }
 exports.assertFunction = assertFunction;
 /**
@@ -154,7 +154,7 @@ exports.assertFunction = assertFunction;
  * @throws {@link AssertionFailedError} If the value was not a JSON value type.
  */
 function assertAnyJson(value, message) {
-    assertNonNull(to_1.toAnyJson(value), message || 'Value is not a JSON-compatible value type');
+    assertNonNull((0, to_1.toAnyJson)(value), message ?? 'Value is not a JSON-compatible value type');
 }
 exports.assertAnyJson = assertAnyJson;
 /**
@@ -165,7 +165,7 @@ exports.assertAnyJson = assertAnyJson;
  * @throws {@link AssertionFailedError} If the value was undefined.
  */
 function assertJsonMap(value, message) {
-    assertNonNull(as_1.asJsonMap(value), message || 'Value is not a JsonMap');
+    assertNonNull((0, as_1.asJsonMap)(value), message ?? 'Value is not a JsonMap');
 }
 exports.assertJsonMap = assertJsonMap;
 /**
@@ -176,7 +176,7 @@ exports.assertJsonMap = assertJsonMap;
  * @throws {@link AssertionFailedError} If the value was undefined.
  */
 function assertJsonArray(value, message) {
-    assertNonNull(as_1.asJsonArray(value), message || 'Value is not a JsonArray');
+    assertNonNull((0, as_1.asJsonArray)(value), message ?? 'Value is not a JsonArray');
 }
 exports.assertJsonArray = assertJsonArray;
 //# sourceMappingURL=assert.js.map

package/lib/narrowing/coerce.d.ts

@@ -30,7 +30,7 @@ export declare function coerceJsonMap<T extends object>(value: Nullable<T>): Opt
  * Narrows an object of type `T` to a `JsonMap` using a shallow type-compatibility check. Use this when the source of
  * the object is known to be JSON-compatible and you want simple type coercion to a `JsonMap`. Use {@link toJsonMap}
  * instead when the `value` object _cannot_ be guaranteed to be JSON-compatible and you want an assurance of runtime
- * type safety. This is a shortcut for writing `asJsonMap(coerceAnyJson(value)) || defaultValue`.
+ * type safety. This is a shortcut for writing `asJsonMap(coerceAnyJson(value)) ?? defaultValue`.
  *
  * @param value The object to coerce.
  * @param defaultValue The default to return if `value` was not defined.
@@ -49,7 +49,7 @@ export declare function coerceJsonArray<T>(value: Nullable<T[]>): Optional<JsonA
  * Narrows an array of type `T` to a `JsonArray` using a shallow type-compatibility check. Use this when the source of
  * the array is known to be JSON-compatible and you want simple type coercion to a `JsonArray`. Use {@link toJsonArray}
  * instead when the `value` array _cannot_ be guaranteed to be JSON-compatible and you want an assurance of runtime
- * type safety. This is a shortcut for writing `asJsonArray(coerceAnyJson(value)) || defaultValue`.
+ * type safety. This is a shortcut for writing `asJsonArray(coerceAnyJson(value)) ?? defaultValue`.
  *
  * @param value The array to coerce.
  * @param defaultValue The default to return if `value` was not defined.

package/lib/narrowing/coerce.js

@@ -11,17 +11,17 @@ const as_1 = require("./as");
 const is_1 = require("./is");
 // underlying function
 function coerceAnyJson(value, defaultValue) {
-    return is_1.isAnyJson(value) ? value : defaultValue;
+    return (0, is_1.isAnyJson)(value) ? value : defaultValue;
 }
 exports.coerceAnyJson = coerceAnyJson;
 // underlying function
 function coerceJsonMap(value, defaultValue) {
-    return as_1.asJsonMap(coerceAnyJson(value)) || defaultValue;
+    return (0, as_1.asJsonMap)(coerceAnyJson(value)) ?? defaultValue;
 }
 exports.coerceJsonMap = coerceJsonMap;
 // underlying method
 function coerceJsonArray(value, defaultValue) {
-    return as_1.asJsonArray(coerceAnyJson(value)) || defaultValue;
+    return (0, as_1.asJsonArray)(coerceAnyJson(value)) ?? defaultValue;
 }
 exports.coerceJsonArray = coerceJsonArray;
 //# sourceMappingURL=coerce.js.map

package/lib/narrowing/ensure.js

@@ -27,7 +27,7 @@ const to_1 = require("./to");
  */
 function ensure(value, message) {
     if (value == null) {
-        throw new errors_1.UnexpectedValueTypeError(message || 'Value is not defined');
+        throw new errors_1.UnexpectedValueTypeError(message ?? 'Value is not defined');
     }
     return value;
 }
@@ -40,7 +40,7 @@ exports.ensure = ensure;
  * @throws {@link UnexpectedValueTypeError} If the value was undefined.
  */
 function ensureString(value, message) {
-    return ensure(as_1.asString(value), message || 'Value is not a string');
+    return ensure((0, as_1.asString)(value), message ?? 'Value is not a string');
 }
 exports.ensureString = ensureString;
 /**
@@ -51,7 +51,7 @@ exports.ensureString = ensureString;
  * @throws {@link UnexpectedValueTypeError} If the value was undefined.
  */
 function ensureNumber(value, message) {
-    return ensure(as_1.asNumber(value), message || 'Value is not a number');
+    return ensure((0, as_1.asNumber)(value), message ?? 'Value is not a number');
 }
 exports.ensureNumber = ensureNumber;
 /**
@@ -62,7 +62,7 @@ exports.ensureNumber = ensureNumber;
  * @throws {@link UnexpectedValueTypeError} If the value was undefined.
  */
 function ensureBoolean(value, message) {
-    return ensure(as_1.asBoolean(value), message || 'Value is not a boolean');
+    return ensure((0, as_1.asBoolean)(value), message ?? 'Value is not a boolean');
 }
 exports.ensureBoolean = ensureBoolean;
 /**
@@ -73,7 +73,7 @@ exports.ensureBoolean = ensureBoolean;
  * @throws {@link UnexpectedValueTypeError} If the value was undefined.
  */
 function ensureObject(value, message) {
-    return ensure(as_1.asObject(value), message || 'Value is not an object');
+    return ensure((0, as_1.asObject)(value), message ?? 'Value is not an object');
 }
 exports.ensureObject = ensureObject;
 /**
@@ -85,7 +85,7 @@ exports.ensureObject = ensureObject;
  * @throws {@link UnexpectedValueTypeError} If the value was undefined.
  */
 function ensurePlainObject(value, message) {
-    return ensure(as_1.asPlainObject(value), message || 'Value is not a plain object');
+    return ensure((0, as_1.asPlainObject)(value), message ?? 'Value is not a plain object');
 }
 exports.ensurePlainObject = ensurePlainObject;
 /**
@@ -97,7 +97,7 @@ exports.ensurePlainObject = ensurePlainObject;
  * @throws {@link UnexpectedValueTypeError} If the value was undefined.
  */
 function ensureDictionary(value, message) {
-    return ensure(as_1.asDictionary(value), message || 'Value is not a dictionary object');
+    return ensure((0, as_1.asDictionary)(value), message ?? 'Value is not a dictionary object');
 }
 exports.ensureDictionary = ensureDictionary;
 /**
@@ -109,7 +109,7 @@ exports.ensureDictionary = ensureDictionary;
  * @throws {@link UnexpectedValueTypeError} If the value was undefined.
  */
 function ensureInstance(value, ctor, message) {
-    return ensure(as_1.asInstance(value, ctor), message || `Value is not an instance of ${ctor.name}`);
+    return ensure((0, as_1.asInstance)(value, ctor), message ?? `Value is not an instance of ${ctor.name}`);
 }
 exports.ensureInstance = ensureInstance;
 /**
@@ -120,7 +120,7 @@ exports.ensureInstance = ensureInstance;
  * @throws {@link UnexpectedValueTypeError} If the value was undefined.
  */
 function ensureArray(value, message) {
-    return ensure(as_1.asArray(value), message || 'Value is not an array');
+    return ensure((0, as_1.asArray)(value), message ?? 'Value is not an array');
 }
 exports.ensureArray = ensureArray;
 /**
@@ -131,7 +131,7 @@ exports.ensureArray = ensureArray;
  * @throws {@link UnexpectedValueTypeError} If the value was undefined.
  */
 function ensureFunction(value, message) {
-    return ensure(as_1.asFunction(value), message || 'Value is not a function');
+    return ensure((0, as_1.asFunction)(value), message ?? 'Value is not a function');
 }
 exports.ensureFunction = ensureFunction;
 /**
@@ -144,7 +144,7 @@ exports.ensureFunction = ensureFunction;
  * @throws {@link UnexpectedValueTypeError} If the value was not a JSON value type.
  */
 function ensureAnyJson(value, message) {
-    return ensure(to_1.toAnyJson(value), message || 'Value is not a JSON-compatible value type');
+    return ensure((0, to_1.toAnyJson)(value), message ?? 'Value is not a JSON-compatible value type');
 }
 exports.ensureAnyJson = ensureAnyJson;
 /**
@@ -155,7 +155,7 @@ exports.ensureAnyJson = ensureAnyJson;
  * @throws {@link UnexpectedValueTypeError} If the value was undefined.
  */
 function ensureJsonMap(value, message) {
-    return ensure(as_1.asJsonMap(value), message || 'Value is not a JsonMap');
+    return ensure((0, as_1.asJsonMap)(value), message ?? 'Value is not a JsonMap');
 }
 exports.ensureJsonMap = ensureJsonMap;
 /**
@@ -166,7 +166,7 @@ exports.ensureJsonMap = ensureJsonMap;
  * @throws {@link UnexpectedValueTypeError} If the value was undefined.
  */
 function ensureJsonArray(value, message) {
-    return ensure(as_1.asJsonArray(value), message || 'Value is not a JsonArray');
+    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

@@ -35,73 +35,73 @@ const internal_1 = require("./internal");
  * @param defaultValue The default to return if the query result was not defined.
  */
 function get(from, path, defaultValue) {
-    return internal_1.valueOrDefault(path
+    return (0, internal_1.valueOrDefault)(path
         // keep values in quotes together
         .split(/['"]/)
         // values in quotes will always be odd indexes, split the non-quotes values as normal
         .reduce((r, p, index) => (index % 2 === 1 ? [...r, p] : [...r, ...p.split(/[.[\]]/)]), [])
         .filter((p) => !!p)
-        .reduce((r, p) => (has_1.has(r, p) ? r[p] : undefined), from), defaultValue);
+        .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 internal_1.valueOrDefault(as_1.asString(get(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 internal_1.valueOrDefault(as_1.asNumber(get(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 internal_1.valueOrDefault(as_1.asBoolean(get(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 internal_1.valueOrDefault(as_1.asObject(get(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 internal_1.valueOrDefault(as_1.asPlainObject(get(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 internal_1.valueOrDefault(as_1.asDictionary(get(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 internal_1.valueOrDefault(as_1.asInstance(get(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 internal_1.valueOrDefault(as_1.asArray(get(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 internal_1.valueOrDefault(as_1.asFunction(get(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 internal_1.valueOrDefault(coerce_1.coerceAnyJson(get(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 internal_1.valueOrDefault(as_1.asJsonMap(getAnyJson(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 internal_1.valueOrDefault(as_1.asJsonArray(getAnyJson(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.d.ts

@@ -20,7 +20,7 @@ import { AnyArray, AnyConstructor, AnyFunction, AnyJson, JsonArray, JsonMap, Man
  * @param value The value to test.
  * @param keys One or more `string` keys to check for existence.
  */
-export declare function has<T extends unknown, K extends string>(value: T, keys: Many<K>): value is T & object & View<K>;
+export declare function has<T, K extends string>(value: T, keys: Many<K>): value is T & object & View<K>;
 /**
  * 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
@@ -39,7 +39,7 @@ export declare function has<T extends unknown, K extends string>(value: T, keys:
  * @param value The value to test.
  * @param keys A `string` key to check for existence.
  */
-export declare function hasString<T extends unknown, K extends string>(value: T, key: K): value is T & object & View<K, string>;
+export declare function hasString<T, K extends string>(value: T, key: K): value is T & object & View<K, string>;
 /**
  * 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
@@ -58,7 +58,7 @@ export declare function hasString<T extends unknown, K extends string>(value: T,
  * @param value The value to test.
  * @param keys A `number` key to check for existence.
  */
-export declare function hasNumber<T extends unknown, K extends string>(value: T, key: K): value is T & object & View<K, number>;
+export declare function hasNumber<T, K extends string>(value: T, key: K): value is T & object & View<K, number>;
 /**
  * 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
@@ -77,7 +77,7 @@ export declare function hasNumber<T extends unknown, K extends string>(value: T,
  * @param value The value to test.
  * @param keys A `boolean` key to check for existence.
  */
-export declare function hasBoolean<T extends unknown, K extends string>(value: T, key: K): value is T & object & View<K, boolean>;
+export declare function hasBoolean<T, K extends string>(value: T, key: K): value is T & object & View<K, boolean>;
 /**
  * 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
@@ -98,7 +98,7 @@ export declare function hasBoolean<T extends unknown, K extends string>(value: T
  * @param value The value to test.
  * @param keys An `object` key to check for existence.
  */
-export declare function hasObject<V extends object = object, T extends unknown = unknown, K extends string = string>(value: T, key: K): value is T & object & View<K, V>;
+export declare function hasObject<V extends object = object, T = unknown, K extends string = string>(value: T, key: K): value is T & object & View<K, V>;
 /**
  * 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
@@ -120,7 +120,7 @@ export declare function hasObject<V extends object = object, T extends unknown =
  * @param value The value to test.
  * @param keys A "plain" `object` key to check for existence.
  */
-export declare function hasPlainObject<V extends object = object, T extends unknown = unknown, K extends string = string>(value: T, key: K): value is T & object & View<K, V>;
+export declare function hasPlainObject<V extends object = object, T = unknown, K extends string = string>(value: T, key: K): value is T & object & View<K, V>;
 /**
  * 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
@@ -142,7 +142,7 @@ export declare function hasPlainObject<V extends object = object, T extends unkn
  * @param value The value to test.
  * @param keys A "dictionary" `object` key to check for existence.
  */
-export declare function hasDictionary<V = unknown, T extends unknown = unknown, K extends string = string>(value: T, key: K): value is T & object & View<K, Dictionary<V>>;
+export declare function hasDictionary<V = unknown, T = unknown, K extends string = string>(value: T, key: K): value is T & object & View<K, Dictionary<V>>;
 /**
  * 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
@@ -165,7 +165,7 @@ export declare function hasDictionary<V = unknown, T extends unknown = unknown,
  * @param value The value to test.
  * @param keys An instance of type `C` key to check for existence.
  */
-export declare function hasInstance<T extends unknown, K extends string, C extends AnyConstructor>(value: Optional<T>, key: K, ctor: C): value is T & View<K, InstanceType<C>>;
+export declare function hasInstance<T, K extends string, C extends AnyConstructor>(value: Optional<T>, key: K, ctor: C): value is T & View<K, InstanceType<C>>;
 /**
  * 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
@@ -184,7 +184,7 @@ export declare function hasInstance<T extends unknown, K extends string, C exten
  * @param value The value to test.
  * @param keys An `AnyArray` key to check for existence.
  */
-export declare function hasArray<T extends unknown, K extends string>(value: Optional<T>, key: K): value is T & object & View<K, AnyArray>;
+export declare function hasArray<T, K extends string>(value: Optional<T>, key: K): value is T & object & View<K, AnyArray>;
 /**
  * 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
@@ -202,7 +202,7 @@ export declare function hasArray<T extends unknown, K extends string>(value: Opt
  * @param value The value to test.
  * @param keys An `AnyFunction` key to check for existence.
  */
-export declare function hasFunction<T extends unknown, K extends string>(value: Optional<T>, key: K): value is T & object & View<K, AnyFunction>;
+export declare function hasFunction<T, K extends string>(value: Optional<T>, key: K): value is T & object & View<K, AnyFunction>;
 /**
  * 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
@@ -220,7 +220,7 @@ export declare function hasFunction<T extends unknown, K extends string>(value:
  * @param value The value to test.
  * @param keys An `AnyJson` key to check for existence.
  */
-export declare function hasAnyJson<T extends unknown, K extends string>(value: Optional<T>, key: K): value is T & object & View<K, AnyJson>;
+export declare function hasAnyJson<T, K extends string>(value: Optional<T>, key: K): value is T & object & View<K, AnyJson>;
 /**
  * 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

package/lib/narrowing/has.js

@@ -30,7 +30,7 @@ const is_1 = require("./is");
  * @param keys One or more `string` keys to check for existence.
  */
 function has(value, keys) {
-    return is_1.isObject(value) && (is_1.isArray(keys) ? keys.every((k) => k in value) : keys in value);
+    return (0, is_1.isObject)(value) && ((0, is_1.isArray)(keys) ? keys.every((k) => k in value) : keys in value);
 }
 exports.has = has;
 /**
@@ -52,7 +52,7 @@ exports.has = has;
  * @param keys A `string` key to check for existence.
  */
 function hasString(value, key) {
-    return has(value, key) && is_1.isString(value[key]);
+    return has(value, key) && (0, is_1.isString)(value[key]);
 }
 exports.hasString = hasString;
 /**
@@ -74,7 +74,7 @@ exports.hasString = hasString;
  * @param keys A `number` key to check for existence.
  */
 function hasNumber(value, key) {
-    return has(value, key) && is_1.isNumber(value[key]);
+    return has(value, key) && (0, is_1.isNumber)(value[key]);
 }
 exports.hasNumber = hasNumber;
 /**
@@ -96,7 +96,7 @@ exports.hasNumber = hasNumber;
  * @param keys A `boolean` key to check for existence.
  */
 function hasBoolean(value, key) {
-    return has(value, key) && is_1.isBoolean(value[key]);
+    return has(value, key) && (0, is_1.isBoolean)(value[key]);
 }
 exports.hasBoolean = hasBoolean;
 /**
@@ -120,7 +120,7 @@ exports.hasBoolean = hasBoolean;
  * @param keys An `object` key to check for existence.
  */
 function hasObject(value, key) {
-    return has(value, key) && is_1.isObject(value[key]);
+    return has(value, key) && (0, is_1.isObject)(value[key]);
 }
 exports.hasObject = hasObject;
 /**
@@ -145,7 +145,7 @@ exports.hasObject = hasObject;
  * @param keys A "plain" `object` key to check for existence.
  */
 function hasPlainObject(value, key) {
-    return has(value, key) && is_1.isPlainObject(value[key]);
+    return has(value, key) && (0, is_1.isPlainObject)(value[key]);
 }
 exports.hasPlainObject = hasPlainObject;
 /**
@@ -170,7 +170,7 @@ exports.hasPlainObject = hasPlainObject;
  * @param keys A "dictionary" `object` key to check for existence.
  */
 function hasDictionary(value, key) {
-    return has(value, key) && is_1.isDictionary(value[key]);
+    return has(value, key) && (0, is_1.isDictionary)(value[key]);
 }
 exports.hasDictionary = hasDictionary;
 /**
@@ -218,7 +218,7 @@ exports.hasInstance = hasInstance;
  * @param keys An `AnyArray` key to check for existence.
  */
 function hasArray(value, key) {
-    return has(value, key) && is_1.isArray(value[key]);
+    return has(value, key) && (0, is_1.isArray)(value[key]);
 }
 exports.hasArray = hasArray;
 /**
@@ -239,7 +239,7 @@ exports.hasArray = hasArray;
  * @param keys An `AnyFunction` key to check for existence.
  */
 function hasFunction(value, key) {
-    return has(value, key) && is_1.isFunction(value[key]);
+    return has(value, key) && (0, is_1.isFunction)(value[key]);
 }
 exports.hasFunction = hasFunction;
 /**
@@ -260,7 +260,7 @@ exports.hasFunction = hasFunction;
  * @param keys An `AnyJson` key to check for existence.
  */
 function hasAnyJson(value, key) {
-    return has(value, key) && is_1.isAnyJson(value[key]);
+    return has(value, key) && (0, is_1.isAnyJson)(value[key]);
 }
 exports.hasAnyJson = hasAnyJson;
 /**
@@ -280,7 +280,7 @@ exports.hasAnyJson = hasAnyJson;
  * @param keys A `JsonMap` key to check for existence.
  */
 function hasJsonMap(value, key) {
-    return hasAnyJson(value, key) && is_1.isJsonMap(value[key]);
+    return hasAnyJson(value, key) && (0, is_1.isJsonMap)(value[key]);
 }
 exports.hasJsonMap = hasJsonMap;
 /**
@@ -300,7 +300,7 @@ exports.hasJsonMap = hasJsonMap;
  * @param keys A `JsonArray` key to check for existence.
  */
 function hasJsonArray(value, key) {
-    return hasAnyJson(value, key) && is_1.isJsonArray(value[key]);
+    return hasAnyJson(value, key) && (0, is_1.isJsonArray)(value[key]);
 }
 exports.hasJsonArray = hasJsonArray;
 //# sourceMappingURL=has.js.map

package/lib/narrowing/index.js

@@ -7,7 +7,11 @@
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];

package/lib/narrowing/object.js

@@ -36,7 +36,7 @@ exports.definiteValuesOf = exports.definiteKeysOf = exports.definiteEntriesOf =
  * @param obj The object of interest.
  */
 function keysOf(obj) {
-    return Object.keys(obj || {});
+    return Object.keys(obj ?? {});
 }
 exports.keysOf = keysOf;
 /**
@@ -68,7 +68,7 @@ exports.keysOf = keysOf;
  * @param obj The object of interest.
  */
 function entriesOf(obj) {
-    return Object.entries(obj || {});
+    return Object.entries(obj ?? {});
 }
 exports.entriesOf = entriesOf;
 /**
@@ -100,7 +100,7 @@ exports.entriesOf = entriesOf;
  * @param obj The object of interest.
  */
 function valuesOf(obj) {
-    return Object.values(obj || {});
+    return Object.values(obj ?? {});
 }
 exports.valuesOf = valuesOf;
 /**

package/lib/narrowing/to.js

@@ -21,12 +21,12 @@ function toAnyJson(value, defaultValue) {
 exports.toAnyJson = toAnyJson;
 // underlying function
 function toJsonMap(value, defaultValue) {
-    return as_1.asJsonMap(toAnyJson(value)) || defaultValue;
+    return (0, as_1.asJsonMap)(toAnyJson(value)) ?? defaultValue;
 }
 exports.toJsonMap = toJsonMap;
 // underlying method
 function toJsonArray(value, defaultValue) {
-    return as_1.asJsonArray(toAnyJson(value)) || defaultValue;
+    return (0, as_1.asJsonArray)(toAnyJson(value)) ?? defaultValue;
 }
 exports.toJsonArray = toJsonArray;
 //# sourceMappingURL=to.js.map

package/lib/types/index.js

@@ -7,7 +7,11 @@
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@salesforce/ts-types",
-  "version": "1.5.20",
+  "version": "1.7.0",
   "description": "Types and related utilities for TypeScript",
   "main": "lib/index.js",
-  "repository": "https://github.com/forcedotcom/sfdx-dev-packages",
+  "repository": "forcedotcom/ts-types",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "types": "lib/index.d.ts",
@@ -13,13 +13,15 @@
   ],
   "scripts": {
     "build": "sf-build",
+    "ci-docs": "yarn sf-ci-docs",
     "clean": "sf-clean",
     "clean-all": "sf-clean all",
     "compile": "sf-compile",
     "docs": "sf-docs",
     "format": "sf-format",
     "lint": "sf-lint",
-    "prepack": "sf-build",
+    "prepack": "sf-prepack",
+    "prepare": "sf-install",
     "pretest": "sf-compile-test",
     "test": "sf-test"
   },
@@ -27,28 +29,28 @@
     "tslib": "^2.2.0"
   },
   "devDependencies": {
-    "@salesforce/dev-config": "^2.1.2",
-    "@salesforce/dev-scripts": "^0.9.18",
+    "@salesforce/dev-config": "^3.0.0",
+    "@salesforce/dev-scripts": "^3.1.0",
     "@salesforce/prettier-config": "^0.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.2.0",
-    "@typescript-eslint/parser": "^4.2.0",
+    "@typescript-eslint/eslint-plugin": "^5.40.0",
+    "@typescript-eslint/parser": "^5.40.1",
     "chai": "^4.2.0",
-    "eslint": "^7.27.0",
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-config-salesforce": "^0.1.7",
+    "eslint": "^8.25.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-salesforce": "^1.1.0",
     "eslint-config-salesforce-license": "^0.1.6",
-    "eslint-config-salesforce-typescript": "^0.2.8",
+    "eslint-config-salesforce-typescript": "^1.1.1",
     "eslint-plugin-header": "^3.0.0",
-    "eslint-plugin-import": "2.23.4",
-    "eslint-plugin-jsdoc": "^35.1.2",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-jsdoc": "^39.3.6",
     "eslint-plugin-prefer-arrow": "^1.2.1",
-    "eslint-plugin-prettier": "^3.1.3",
-    "mocha": "^8.4.0",
+    "husky": "^7.0.4",
+    "mocha": "^9.1.3",
     "nyc": "^15.1.0",
-    "prettier": "^2.0.5",
+    "prettier": "^2.7.1",
     "pretty-quick": "^3.1.0",
     "sinon": "10.0.0",
     "ts-node": "^10.0.0",
-    "typescript": "^4.1.3"
+    "typescript": "^4.8.4"
   }
-}
+}