@trakit/objects 0.0.1 → 0.0.6

package/{API → _publish/API}/Base.d.ts

@@ -1,4 +1,5 @@
 import { IDeserializable } from './Interfaces/IDeserializable';
+import { JsonObject, nothing } from './Types';
 /**
  * A base class used to construct objects from the sync system.
  */
@@ -7,12 +8,12 @@ export declare abstract class Base implements IDeserializable {
      * Almost all objects can be constructed using a simple JSON object.
      * @param json
      */
-    constructor(json?: any | null);
+    constructor(json?: JsonObject | nothing);
     /**
      * Updates this class from the given input.
      * @param json      A JSON value used to update this class.
      * @param forced    When true, forces the update.
      * @returns True when an update was completed.
      */
-    abstract fromJSON(json: any, force?: boolean): boolean;
+    abstract fromJSON(json: JsonObject, force?: boolean): boolean;
 }

package/{API → _publish/API}/BaseComponent.d.ts

@@ -1,12 +1,15 @@
 import { Base } from './Base';
 import { IRequestable } from './Interfaces/IRequestable';
 import { ISerializable } from './Interfaces/ISerializable';
-import { int } from './Types';
+import { email, guid, int, ulong } from './Types';
 /**
  * Any derived class can/should be serialized and given to a user.
  */
 export declare abstract class BaseComponent extends Base implements IRequestable, ISerializable {
-    #private;
+    /**
+     * Object version keys used to validate synchronization for all object properties.
+     */
+    private _version;
     /**
      * Object version keys used to validate synchronization for all object properties.
      */
@@ -24,11 +27,11 @@ export declare abstract class BaseComponent extends Base implements IRequestable
      */
     protected updateVersions(versions?: int[]): boolean[];
     /**
-     * Returns a string which can be used as a unique identifier for this object.
-     * Strings are unique for each type of object, but can be identical for different object types.
-     * @returns A string unique for this type of object.
+     * Returns a value which can be used as a unique identifier for this object.
+     * Values are unique for each type of object, but can be identical for different object types.
+     * @returns A value unique for this type of object.
      */
-    abstract getKey(): string;
+    abstract getKey(): ulong | email | guid | string;
     /**
      * Creates a literal of this {@link BaseComponent}.
      * Used internally by {@link JSON.stringify}.

package/_publish/API/Codifier.d.ts

@@ -0,0 +1,15 @@
+import { codified } from "./Types";
+/**
+ * Creates a searchable/coded string based on a user inputted string.  Quotation marks, apostrophes, and accents are removed.
+ * @param input
+ */
+export declare function CODIFY(input: string): codified;
+/**
+ * Wraps the {@code input} using the codified {@code terms} with the {@code prefix}s and {@code suffix}s.
+ * When a term is found beside a quotation mark or apostrophe, the mark is included inside the highlight.
+ * @param input		The string to add HTML highlights to.
+ * @param terms		Codified search terms from {@link CODIFY}.
+ * @param prefix	Added to the beginning of each of the {@code terms}.
+ * @param suffix	Added to the end of each of the {@code terms}.
+ */
+export declare function HIGHLIGHT(input: string, terms: codified[], [prefix, suffix]?: [string, string]): string;

package/_publish/API/Encoding.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Encodes the given string as a {@link Provider#password}.
+ */
+export declare function PASSWORD_ENCODE(value: string): string;
+/**
+ * Decodes the given {@link Provider#password} as a human readable value.
+ * @param value
+ * */
+export declare function PASSWORD_DECODE(value: string): string;

package/{API → _publish/API}/Files.d.ts

@@ -11,11 +11,11 @@ export declare function NUMBER_GROUPS(number: number, size?: number, delimiter?:
 /**
  * Creates a more human readable string representation of the filesize.
  * @param bytes
- * @param places				The number of decimal places.  Default is 1.
- * @param maxScale			Largest size-scale to use for representing the file-size.  Default is 2 (Megabyte), can be a value between 0 (Byte) and 6 (Exabyte).
+ * @param places			The number of decimal places.  Default is 0.
+ * @param maxScale			Largest size-scale to use for representing the file-size.  Default is "MB" (Megabyte), can be a value between 0 (Byte) and 6 (Exabyte).
  * @param groupSize			Quantity of digits per number group.  The default is 3.
- * @param groupDelimiter		Character(s) to use to divide the integer groups.  The detauls is ",".
+ * @param groupDelimiter	Character(s) to use to divide the integer groups.  The detauls is ",".
  * @param decimalDelimiter	Character(s) to use to divide the decimal groups.  The detauls is same as delimiter.
  * @param point				Character(s) to use to divide the integer groups from the decimal groups. The detauls is ".".
  * */
-export declare function FILESIZE_HELPER(bytes: number, places?: number, maxScale?: number, groupSize?: number, groupDelimiter?: string, decimalDelimiter?: string, point?: string): string;
+export declare function FILESIZE_HELPER(bytes: number, places?: number, maxScale?: string, groupSize?: number, groupDelimiter?: string, decimalDelimiter?: string, point?: string): string;

package/{API → _publish/API}/Functions.d.ts

@@ -1,10 +1,9 @@
-import { ISerializable } from "./Interfaces/ISerializable";
-import { datetime } from "./Types";
+import { datetime, JsonObject, nothing } from "./Types";
 /**
  * Checks for both null and undefined
  * @param value The variable to check
  */
-export declare function IS_NOTHING(value: any): value is null | undefined;
+export declare function IS_NOTHING(value: any): value is nothing;
 /**
  * Checks to see if the given parameter is a number object or number literal.
  * @param value The variable to check
@@ -65,7 +64,7 @@ export declare function ID(value: any): number;
  * Creates a Date object out of the given value.
  * @param value
  */
-export declare function DATE(value?: Date | number | datetime): Date;
+export declare function DATE(value?: Date | number | datetime | nothing): Date;
 /**
  * An implementation of the Douglas-Peucker path reduction algorithm.
  * @template TCoord			A type of coordinate like a pixel or lat/lng.
@@ -87,13 +86,26 @@ export declare function DOUGLASPEUCKER_INTERNAL<TCoord>(source: TCoord[], triang
  */
 export declare function DOUGLASPEUCKER<TCoord>(source: TCoord[], triangleHeight: (first: TCoord, middle: TCoord, last: TCoord) => number, tolerance: number): TCoord[];
 /**
- * Encodes the given string as a Provider password.
+ * Returns a plural version of the given word.
+ * This obviously doesn't work for every word imaginable, but covers the standard object names in the Trak-iT APIs.
+ * @param word
+ * @returns
+ */
+export declare function PLURALIZE(word: string): string;
+/**
+ * Returns a singular version of the given word.
+ * This obviously doesn't work for every word imaginable, but covers the standard object names in the Trak-iT APIs.
+ * @param word
+ * @returns
  */
-export declare function PASSWORD_ENCODE(value: string): string;
+export declare function SINGULARIZE(word: string): string;
 /**
- * Decodes the given Provider password as a human readable value.
+ * Returns the given word with the first letter capitalized (or lower-cased).
+ * @param word
+ * @param upper
+ * @returns
  */
-export declare function PASSWORD_DECODE(value: string): string;
+export declare function CAPITALIZE(word: string, upper?: boolean): string;
 /**
  * Parses the input and returns a valid phone number prefixed by 1, or NaN if invalid.
  * @param phone
@@ -113,49 +125,42 @@ export declare function ZERO_PADDED(num: number, length: number, decimals?: numb
  * @param deep
  * @returns
  */
-export declare function MAP_TO_OBJECT(source: Map<any, any>, deep?: boolean): object;
-/**
- *
- * @param source
- * @param deep
- * @returns
- */
-export declare function MAP_TO_OBJECT_PREDICATE<K, V>(source: Map<K, V>, predicate: (key: K, value: V) => [string, any]): object;
+export declare function MAP_TO_JSON(source: Map<any, any>, deep?: boolean): JsonObject;
 /**
  *
  * @param source
  * @param deep
  * @returns
  */
-export declare function MAP_TO_OBJECT_VALUE_JSON<V extends ISerializable>(source: Map<any, V>): object;
+export declare function MAP_TO_JSON_PREDICATE<K, V>(source: Map<K, V>, predicate: (key: K, value: V) => [string, any]): JsonObject;
 /**
  *
  * @param map
  * @param deep
  * @returns
  */
-export declare function OBJECT_TO_MAP_BY_PREDICATE<K, V>(source: object, predicate: (key: string, value: any) => [K, V]): Map<K, V>;
+export declare function JSON_TO_MAP_PREDICATE<K, V>(source: object, predicate: (key: string, value: any) => [K, V]): Map<K, V>;
 /**
  *
  * @param map
  * @param deep
  * @returns
  */
-export declare function OBJECT_TO_MAP(source: object, deep?: boolean): Map<string, any>;
+export declare function JSON_TO_MAP(source: object, deep?: boolean): Map<string, any>;
 /**
  *
  * @param map
  * @param deep
  * @returns
  */
-export declare function OBJECT_TO_MAP_KEY_CODIFIED(source: object, deep?: boolean): Map<string, any>;
+export declare function JSON_TO_MAP_KEY_CODIFIED(source: object, deep?: boolean): Map<string, any>;
 /**
  *
  * @param map
  * @param deep
  * @returns
  */
-export declare function OBJECT_TO_MAP_KEY_ULONG(source: object, deep?: boolean): Map<number, any>;
+export declare function JSON_TO_MAP_KEY_ULONG(source: object, deep?: boolean): Map<number, any>;
 /**
  *
  * @param this

package/{API → _publish/API}/Geography/Functions.d.ts

@@ -1,6 +1,10 @@
 import { IPoint } from '../Geometry/Interfaces';
 import { int } from '../Types';
 import { ILatLng, ILatLngBounds } from './Interfaces';
+/**
+ * The default precision used to serialize latlngs.
+ */
+export declare const DEFAULT_PRECISION = 6;
 /**
  * The radius of the Earth in meters taken from the GRS-80, NAD83, and WGS-84 standards.
  */

package/{API → _publish/API}/Geography/Interfaces.d.ts

@@ -1,3 +1,4 @@
+import { datetime, nothing } from '../Types';
 /**
  * A coordinate on the Earth.
  */
@@ -28,33 +29,37 @@ export declare function ILatLng_clone(dot: ILatLng): ILatLng;
  */
 export interface IPosition extends ILatLng {
     /**
-    Speed
+     * Speed
      */
-    speed: number | null;
+    speed: number | nothing;
     /**
-    Direction of travel
+     * Direction of travel
      */
-    bearing: number | null;
+    bearing: number | nothing;
     /**
-    Distance in meters from the sea level
+     * Distance in meters from the sea level
      */
-    altitude: number | null;
+    altitude: number | nothing;
     /**
-    Threshold in meters for the accuracy of a position
+     * Threshold in meters for the accuracy of a position
      */
-    accuracy: number | null;
+    accuracy: number | nothing;
     /**
-    The Date/Time of the GPS reading
+     * The Date/Time of the GPS reading
      */
-    dts: string | Date;
+    dts: datetime;
     /**
-    A better description of the current road-segment
+     * A description of the current road-segment
      */
-    streetAddress: IStreetAddress | null;
+    address: string | nothing;
     /**
-    The posted speed limit for the road segment
+     * A better description of the current road-segment
      */
-    speedLimit: number | null;
+    streetAddress: IStreetAddress | nothing;
+    /**
+     * The posted speed limit for the road segment
+     */
+    speedLimit: number | nothing;
 }
 /**
  * Returns true if the given pin conforms to the {@link IPosition} interface.

package/{API → _publish/API}/Geography/LatLng.d.ts

@@ -1,4 +1,5 @@
 import { Point } from '../Geometry/Point';
+import { JsonObject } from '../Types';
 import { ILatLng } from './Interfaces';
 import { LatLngBounds } from './LatLngBounds';
 /**
@@ -13,7 +14,14 @@ export declare class LatLng implements ILatLng {
      *
      * @param json
      */
-    static fromJSON(json: any): LatLng;
+    static fromJSON(json: ILatLng | JsonObject): LatLng;
+    /**
+     *
+     * @param latlng
+     * @param delimiter
+     * @returns
+     */
+    static fromString(latlng: string, delimiter?: string): LatLng;
     /**
      * Latitude
      */

package/{API → _publish/API}/Geography/LatLngBounds.d.ts

@@ -1,4 +1,5 @@
 import { ISerializable } from '../Interfaces/ISerializable';
+import { JsonObject } from '../Types';
 import { ILatLng, ILatLngBounds, LatLngBoundsExpansion } from './Interfaces';
 import { LatLng } from './LatLng';
 /**
@@ -9,7 +10,7 @@ export declare class LatLngBounds implements ILatLngBounds, ISerializable {
      *
      * @param json
      */
-    static fromJSON(json: any): LatLngBounds;
+    static fromJSON(json: ILatLngBounds | JsonObject): LatLngBounds;
     /**
      * Northern latitude
      */

package/{API → _publish/API}/Geography/Position.d.ts

@@ -1,4 +1,4 @@
-import { datetime } from '../Types';
+import { datetime, JsonObject, nothing } from '../Types';
 import { IPosition, IStreetAddress } from './Interfaces';
 import { LatLng } from './LatLng';
 import { StreetAddress } from './StreetAddress';
@@ -6,26 +6,32 @@ import { StreetAddress } from './StreetAddress';
  * GPS position information
  */
 export declare class Position extends LatLng implements IPosition {
+    /**
+     *
+     * @param json
+     * @returns
+     */
+    static fromJSON(json: IPosition | JsonObject): Position;
     /**
      * Speed
      */
-    speed: number;
+    readonly speed: number;
     /**
      * Direction of travel
      */
-    bearing: number;
+    readonly bearing: number;
     /**
      * Distance in meters from the sea level
      */
-    altitude: number;
+    readonly altitude: number;
     /**
      * Threshold in meters for the accuracy of a position
      */
-    accuracy: number;
+    readonly accuracy: number;
     /**
      * The Date/Time of the GPS reading
      */
-    date: Date;
+    readonly date: Date;
     /**
      * The Date/Time of the GPS reading
      */
@@ -33,20 +39,20 @@ export declare class Position extends LatLng implements IPosition {
     /**
      * A better description of the current road-segment
      */
-    streetAddress: StreetAddress | null;
+    readonly streetAddress: StreetAddress | null;
     /**
      * The posted speed limit for the road segment
      */
-    speedLimit: number;
+    readonly speedLimit: number | nothing;
     /**
      * Provider Identifier
      */
-    origin: string;
+    readonly origin: string;
     /**
      * The road segment description
      */
-    get address(): string;
-    constructor(lat?: number, lng?: number, speed?: number, bearing?: number, accuracy?: number, dts?: Date | number | datetime, limit?: number, altitude?: number, street?: IStreetAddress);
+    readonly address: string;
+    constructor(lat?: number | nothing, lng?: number | nothing, speed?: number | nothing, bearing?: number | nothing, accuracy?: number | nothing, dts?: Date | number | datetime | nothing, address?: string | nothing, limit?: number | nothing, altitude?: number | nothing, street?: IStreetAddress | JsonObject | nothing);
     /**
      * Returns a text representation of this position.
      * Returned strings cannot be converted back into {@link Position}
@@ -59,4 +65,10 @@ export declare class Position extends LatLng implements IPosition {
      * Used internally by {@link JSON.stringify}.
      */
     toJSON(): IPosition;
+    /**
+     *
+     * @param position
+     * @returns
+     */
+    isEqual(position: Position | IPosition): boolean;
 }

package/{API → _publish/API}/Geography/StreetAddress.d.ts

@@ -1,4 +1,5 @@
 import { ISerializable } from "../Interfaces/ISerializable";
+import { JsonObject, nothing } from "../Types";
 import { IStreetAddress } from "./Interfaces";
 /**
  * A road segment description
@@ -8,7 +9,7 @@ export declare class StreetAddress implements IStreetAddress, ISerializable {
      *
      * @param street
      */
-    static fromJSON(json: any): StreetAddress;
+    static fromJSON(json: IStreetAddress | JsonObject): StreetAddress;
     /**
      * House number.
      */
@@ -43,7 +44,7 @@ export declare class StreetAddress implements IStreetAddress, ISerializable {
      * Indicates that there is a toll for the current road segment.
      */
     isToll: boolean;
-    constructor(number?: string | null, street?: string | null, city?: string | null, region?: string | null, province?: string, country?: string, postal?: string | null, isToll?: boolean);
+    constructor(number?: string | nothing, street?: string | nothing, city?: string | nothing, region?: string | nothing, province?: string | nothing, country?: string | nothing, postal?: string | nothing, isToll?: boolean | nothing);
     /**
      * Returns a text representation of this address.
      * Returned strings cannot be converted back into {@link StreetAddress}

package/{API → _publish/API}/Geometry/Functions.d.ts

@@ -77,7 +77,7 @@ export declare function RADIAL_AREA(radius: number): number;
  * @param points	The array of points on which to create the Radial
  * @param iterations	The higher the iterations the slower and more accurate the Radial. Default is 10,000.
  * */
-export declare function RADIAL_BADOIU_CLARKSON(points: IPoint[], iterations: number): IRadial;
+export declare function RADIAL_BADOIU_CLARKSON(points: IPoint[], iterations?: number): IRadial;
 /**
  * Calculates the circumference of a circle based on the given radius.
  * @param radius

package/{API → _publish/API}/Geometry/Point.d.ts

@@ -1,6 +1,7 @@
+import { ISerializable } from '../Interfaces/ISerializable';
+import { JsonObject } from '../Types';
 import { IPoint } from './Interfaces';
 import { Radial } from './Radial';
-import { ISerializable } from '../Interfaces/ISerializable';
 /**
  * A coordinate on a flat surface.
  */
@@ -9,7 +10,7 @@ export declare class Point implements IPoint, ISerializable {
      * Returns a new {@link Radial} from the given object.
      * @param json
      */
-    static fromJSON(json: any): Point;
+    static fromJSON(json: IPoint | JsonObject): Point;
     /**
      * Horizontal coordinate.
      */
@@ -39,7 +40,7 @@ export declare class Point implements IPoint, ISerializable {
      * @param point	The other {@link Point} to compare.
      * @param precision	The degree of precision to use; default is full precision.
      */
-    isEquals(point: IPoint, precision?: number): point is IPoint;
+    isEqual(point: IPoint, precision?: number): point is IPoint;
     /**
      * Calculates the distance between two {@link Point}s.
      * @param point	The other {@link Point} to compare

package/{API → _publish/API}/Geometry/Radial.d.ts

@@ -1,8 +1,9 @@
+import { ISerializable } from '../Interfaces/ISerializable';
+import { JsonObject } from '../Types';
 import { IPoint, IRadial, RadialExpansion } from './Interfaces';
 import { Point } from './Point';
-import { Size } from './Size';
 import { Rectangle } from './Rectangle';
-import { ISerializable } from '../Interfaces/ISerializable';
+import { Size } from './Size';
 /**
  * A boundary on a flat surface based on a centre point and a radius.
  */
@@ -11,7 +12,7 @@ export declare class Radial implements IRadial, IPoint, ISerializable {
      * Returns a new {@link Radial} from the given object.
      * @param object
      */
-    static fromObject(object: any): Radial;
+    static fromJSON(json: IRadial | JsonObject): Radial;
     /**
      * Left coordinate.
      */
@@ -45,7 +46,7 @@ export declare class Radial implements IRadial, IPoint, ISerializable {
      * @param circle	The other {@link IRadial} to compare
      * @param precision	The degree of precision to use; default is full precision.
      */
-    isEquals(circle: IRadial, precision?: number): boolean;
+    isEqual(circle: IRadial, precision?: number): boolean;
     /**
      * Determines if the given {@link IPoint} is contained by this Radial
      * @param point

package/{API → _publish/API}/Geometry/Rectangle.d.ts

@@ -6,10 +6,11 @@ import { Size } from './Size';
  * A four-sided box on a flat surface.
  */
 export declare class Rectangle implements IRectangle {
+    #private;
     /**
      * Returns a new {@link Radial} from the given object.
      */
-    static fromObject(rectangle: any): IRectangle;
+    static fromJSON(rectangle: any): Rectangle;
     /**
      * Left-most horizontal coordinate
      */
@@ -41,7 +42,7 @@ export declare class Rectangle implements IRectangle {
      * @returns A string in the format of "left,top,right,bottom".
      */
     toString(delimiter?: string): string;
-    /**`
+    /**
      * Creates a literal of this {@link Rectangle}.
      * Used internally by {@link JSON.stringify}.
      */
@@ -98,11 +99,6 @@ export declare class Rectangle implements IRectangle {
      * Returns the {@link Point} at the bottom-most/right-most corner.
      */
     getBottomRight(): Point;
-    /**
-     * Worker function that actually extends the boundary to envelop the given point(s)/boundary(s).
-     * @param object	The objects used to extend the boundary
-     */
-    private __expander;
     /**
      * Validates the boundary by ensuring the top value is less than the bottom value,
      * and the left value is less than the right value.

package/{API → _publish/API}/Geometry/Size.d.ts

@@ -1,9 +1,15 @@
+import { JsonObject } from '../Types';
 import { ISize } from './Interfaces';
 /**
  * Dimensions on a flat surface.
  */
 export declare class Size implements ISize {
-    static fromJSON(json: any): Size;
+    /**
+     *
+     * @param json
+     * @returns
+     */
+    static fromJSON(json: ISize | JsonObject): Size;
     /**
      * Width.
      */
@@ -29,7 +35,7 @@ export declare class Size implements ISize {
      * @param size		The other Size to compare
      * @param precision	The degree of precision to use; default is full precision
      */
-    equals(size: ISize, precision?: number): size is ISize;
+    isEqual(size: ISize, precision?: number): size is ISize;
     /**
      * Returns a new instance of a {@link Size} where the width and height are adjusted to the given ratios.
      * If the second ratio is not given, then the first value is used for both.

package/_publish/API/Interfaces/IAuditable.d.ts

@@ -0,0 +1,31 @@
+/**
+ * For auditable objects, a record of who and what mad the changes.
+*/
+export interface IAuditable {
+    /**
+     * Details about the change to an object.
+     */
+    updated: IAuditableUpdated;
+    /**
+     * When the was change procesed.
+     */
+    processedUtc: Date;
+}
+/**
+ * This class used in conjunction with the {@link version} member help with synchronization.
+*/
+export declare class IAuditableUpdated {
+    /**
+     * The {@link User.login} or {@link Machine.key} when the object is updated,
+     * or {@link Service.UserAgent} if a service updates the object itself.
+     */
+    by: string;
+    /**
+     * A {@link Service.UserAgent} that handled the update.
+     */
+    from: string;
+    /**
+     * Timestamp from when the change was made.
+     */
+    dts: Date;
+}

package/{API → _publish/API}/Interfaces/IDeserializable.d.ts

@@ -1,3 +1,4 @@
+import { JsonObject } from "../../API/Types";
 /**
  * An interface for types that are updated using JSON values.
  */
@@ -8,5 +9,5 @@ export interface IDeserializable {
      * @param forced    When true, forces the update.
      * @returns True when an update was completed.
      */
-    fromJSON(json: any, force?: boolean): boolean;
+    fromJSON(json: JsonObject, force?: boolean): boolean;
 }

package/{API → _publish/API}/Interfaces/ILabelled.d.ts

@@ -1,3 +1,4 @@
+import { codified } from "../Types";
 /**
  * An interface for objects that have "labels".
 */
@@ -5,5 +6,5 @@ export interface ILabelled {
     /**
      * A list of codified labels for this asset or place.
      */
-    labels: string[];
+    labels: codified[];
 }

package/{API → _publish/API}/Interfaces/IRequestable.d.ts

@@ -1,3 +1,4 @@
+import { email, guid, ulong } from "../Types";
 /**
  * The main interface for an object in the Trak-iT system.
 */
@@ -8,11 +9,14 @@ export interface IRequestable {
      * {@link IIdUlong.id}
      * {@link Machine.key}
      * {@link Provider.id}
+     * {@link ProviderGeneral.id}
+     * {@link ProviderAdvanced.id}
+     * {@link ProviderControl.id}
      * {@link ProviderRegistration.code}
      * {@link User.login}
      * {@link UserGeneral.login}
      * {@link UserAdvanced.login}
      * {@link Timezone.code}
      */
-    getKey(): string;
+    getKey(): ulong | email | guid | string;
 }

package/_publish/API/Objects.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Used internally by {@link MERGE}.
+ * @param value
+ */
+export declare function MERGE_INTERNAL(value: any): any;

package/{API → _publish/API}/SearchPattern.d.ts

@@ -1,3 +1,4 @@
+import { nothing } from './Types';
 /**
  * A common structure used to implement searching throughout the system.
  * The input format is described in the {@link /wss/#format-expression|WebSocket reference}.
@@ -7,12 +8,12 @@ export declare class SearchPattern {
      * Creates an array of {@link SearchPattern}s for easier matching.  Used for doing OR matching.
      * @param expression
      */
-    static parse(expression?: string | null): SearchPattern[];
+    static parse(expression?: string | nothing): SearchPattern[];
     /**
      * Creates a single string from the given array of {@link SearchPattern}s for easier serialization.
      * @param patterns
      */
-    static stringify(patterns?: SearchPattern[] | null): string | null;
+    static stringify(patterns?: SearchPattern[] | nothing): string | null;
     /**
      * To help qualify matches, all operators must match for the search to be
      * considered matched.