@vertexvis/utils 0.24.5 → 1.0.0-canary.0

package/dist/objects.d.ts

@@ -1,72 +1,72 @@
-/**
- * Returns a new object where any enumerable property from `other` are
- * recursively applied to `a`. Once a property is set, it will not be
- * overridden. This function is useful for constructing configs from a default
- * config.
- *
- * @example
- * ```
- * defaults({ 'a': [1] }, { 'b': 2 }, { 'a': [2] });
- * // => { a: [1], b: 2 }
- * ```
- */
-export declare function defaults<A>(a: A): A;
-export declare function defaults<A, B>(a: A, b: B): A & B;
-export declare function defaults<A, B, C>(a: A, b: B, c: C): A & B & C;
-export declare function defaults<A, B, C, D>(a: A, b: B, c: C, d: D): A & B & C & D;
-export declare function defaults<A, R>(a: A, ...other: Record<string, unknown>[]): R;
-/**
- * Returns `true` if this is a plain object, which is defined by a type created
- * by the `Object` constructor. Returns `false` otherwise.
- *
- * @example
- * ```
- * isPlainObject(Object.create({})); //=> true
- * isPlainObject(Object.create(Object.prototype)); //=> true
- * isPlainObject({foo: 'bar'}); //=> true
- * isPlainObject({}); //=> true
- *
- * isPlainObject(1); //=> false
- * isPlainObject(['foo', 'bar']); //=> false
- * isPlainObject([]); //=> false
- * isPlainObject(new Foo); //=> false
- * isPlainObject(null); //=> false
- * isPlainObject(Object.create(null)); //=> false
- * ```
- */
-export declare function isPlainObject(obj: unknown): boolean;
-/**
- * Performs a deep comparison of two objects and returns `true` if they're
- * equal.
- *
- * This method supports comparing arrays, array buffers, booleans, date objects,
- * error objects, maps, numbers, Object objects, regexes, sets, strings,
- * symbols, and typed arrays. Object objects are compared by their own, not
- * inherited, enumerable properties. Functions and DOM nodes are compared by
- * strict equality, i.e. ===.
- *
- * @param a The object to compare with `b`.
- * @param b The object to compare with `a`.
- * @returns `true` if the two objects are equal. Otherwise `false`.
- */
-export declare function isEqual(a: unknown, b: unknown): boolean;
-/**
- * Returns an array of key-value pairs for each enumerable key in `obj`.
- *
- * @example
- * ```
- * toPairs({a: 1, b: 2}); //=> [['a', 1], ['b', 2]]
- * toPairs(['a', 'b']); //=> [['0', 'a'], ['1', 'b']]
- *
- * function Foo() {
- *   this.a = 1;
- *   this.b = 2;
- * }
- * toPairs(new Foo()); //=> [['a', 1], ['b', 2]]
- * ```
- */
-export declare function toPairs<T>(obj: Record<string, T>): Array<[string, T]>;
-export declare function toPairs<T>(obj: T[]): Array<[string, T]>;
-export declare function toPairs(obj: object | null | undefined): Array<[string, any]>;
-export declare function fromPairs<T>(pairs: Array<[string, T]> | undefined | null): Record<string, T>;
-export declare function fromPairs(pairs: Array<unknown[]> | undefined | null): Record<string, unknown>;
+/**
+ * Returns a new object where any enumerable property from `other` are
+ * recursively applied to `a`. Once a property is set, it will not be
+ * overridden. This function is useful for constructing configs from a default
+ * config.
+ *
+ * @example
+ * ```
+ * defaults({ 'a': [1] }, { 'b': 2 }, { 'a': [2] });
+ * // => { a: [1], b: 2 }
+ * ```
+ */
+export declare function defaults<A>(a: A): A;
+export declare function defaults<A, B>(a: A, b: B): A & B;
+export declare function defaults<A, B, C>(a: A, b: B, c: C): A & B & C;
+export declare function defaults<A, B, C, D>(a: A, b: B, c: C, d: D): A & B & C & D;
+export declare function defaults<A, R>(a: A, ...other: Record<string, unknown>[]): R;
+/**
+ * Returns `true` if this is a plain object, which is defined by a type created
+ * by the `Object` constructor. Returns `false` otherwise.
+ *
+ * @example
+ * ```
+ * isPlainObject(Object.create({})); //=> true
+ * isPlainObject(Object.create(Object.prototype)); //=> true
+ * isPlainObject({foo: 'bar'}); //=> true
+ * isPlainObject({}); //=> true
+ *
+ * isPlainObject(1); //=> false
+ * isPlainObject(['foo', 'bar']); //=> false
+ * isPlainObject([]); //=> false
+ * isPlainObject(new Foo); //=> false
+ * isPlainObject(null); //=> false
+ * isPlainObject(Object.create(null)); //=> false
+ * ```
+ */
+export declare function isPlainObject(obj: unknown): boolean;
+/**
+ * Performs a deep comparison of two objects and returns `true` if they're
+ * equal.
+ *
+ * This method supports comparing arrays, array buffers, booleans, date objects,
+ * error objects, maps, numbers, Object objects, regexes, sets, strings,
+ * symbols, and typed arrays. Object objects are compared by their own, not
+ * inherited, enumerable properties. Functions and DOM nodes are compared by
+ * strict equality, i.e. ===.
+ *
+ * @param a The object to compare with `b`.
+ * @param b The object to compare with `a`.
+ * @returns `true` if the two objects are equal. Otherwise `false`.
+ */
+export declare function isEqual(a: unknown, b: unknown): boolean;
+/**
+ * Returns an array of key-value pairs for each enumerable key in `obj`.
+ *
+ * @example
+ * ```
+ * toPairs({a: 1, b: 2}); //=> [['a', 1], ['b', 2]]
+ * toPairs(['a', 'b']); //=> [['0', 'a'], ['1', 'b']]
+ *
+ * function Foo() {
+ *   this.a = 1;
+ *   this.b = 2;
+ * }
+ * toPairs(new Foo()); //=> [['a', 1], ['b', 2]]
+ * ```
+ */
+export declare function toPairs<T>(obj: Record<string, T>): Array<[string, T]>;
+export declare function toPairs<T>(obj: T[]): Array<[string, T]>;
+export declare function toPairs(obj: object | null | undefined): Array<[string, any]>;
+export declare function fromPairs<T>(pairs: Array<[string, T]> | undefined | null): Record<string, T>;
+export declare function fromPairs(pairs: Array<unknown[]> | undefined | null): Record<string, unknown>;

package/dist/predicate.d.ts

@@ -1,5 +1,5 @@
-/**
- * Defines a function that takes a value and returns `true` if the condition is
- * satisfied, or `false` if it doesn't.
- */
-export declare type Predicate<T> = (value: T) => boolean;
+/**
+ * Defines a function that takes a value and returns `true` if the condition is
+ * satisfied, or `false` if it doesn't.
+ */
+export type Predicate<T> = (value: T) => boolean;

package/dist/range.d.ts

@@ -1,86 +1,86 @@
-/**
- * A `Range` represents a sequence of numbers from a starting point to ending
- * point.
- */
-export interface Range {
-    start: number;
-    end: number;
-}
-/**
- * Returns a new `Range` with the given start and end points.
- */
-export declare const create: (start: number, end: number) => Range;
-/**
- * Returns a new `Range` with the start and end points at the given position.
- */
-export declare const at: (position: number) => Range;
-/**
- * Returns a new `Range` with the given start point and length.
- */
-export declare const withLength: (start: number, len: number) => Range;
-/**
- * Returns a range with the start and end points shifted by the given distance.
- */
-export declare const add: (distance: number, range: Range) => Range;
-/**
- * Returns a range such that `range` is constrained to the start and end points
- * of `to`. The function will try to maintain the length of the range, but will
- * shrink the range if its length is greater than `to`.
- */
-export declare const constrain: (range: Range, to: Range) => Range;
-/**
- * Checks if the given number or range is contained within another range.
- */
-export declare const contains: (numOrRange: number | Range, range: Range) => boolean;
-/**
- * Returns a range that represents the overlap between `other` and `range`. If
- * the two ranges do not intersect, then `undefined` is returned.
- * @param other
- * @param range
- */
-export declare const intersection: (other: Range, range: Range) => Range | undefined;
-/**
- * Returns `true` if `other` intersects with `range`.
- */
-export declare const intersects: (other: Range, range: Range) => boolean;
-/**
- * Checks if a range has the same starting point as another range.
- */
-export declare const isAt: (other: Range, range: Range) => boolean;
-/**
- * Returns `true` if a range's start point is after the starting point of
- * another range.
- */
-export declare const isAfter: (other: Range, range: Range) => boolean;
-/**
- * Returns `true` if a range start at or is after another range.
- */
-export declare const isAtOrAfter: (other: Range, range: Range) => boolean;
-/**
- * Returns `true` if a range's starting point is before another range's starting
- * point.
- */
-export declare const isBefore: (other: Range, range: Range) => boolean;
-/**
- * Returns `true` if a range's starting point is at or before another range's
- * starting point.
- */
-export declare const isAtOrBefore: (other: Range, range: Range) => boolean;
-/**
- * Returns the length of a range.
- */
-export declare const length: (range: Range) => number;
-/**
- * Returns a `Range` with its start and end points subtracted by the given
- * distance.
- */
-export declare const subtract: (distance: number, range: Range) => Range;
-/**
- * Adjusts either the start or end position of a range so that its contained
- * within another range. Unlike `constrain`, this will not attempt to retain
- * the range's length.
- *
- * If `other` does not intersect with `to`, then the range cannot be truncated
- * and `undefined` is returned.
- */
-export declare const truncate: (other: Range, to: Range) => Range | undefined;
+/**
+ * A `Range` represents a sequence of numbers from a starting point to ending
+ * point.
+ */
+export interface Range {
+    start: number;
+    end: number;
+}
+/**
+ * Returns a new `Range` with the given start and end points.
+ */
+export declare const create: (start: number, end: number) => Range;
+/**
+ * Returns a new `Range` with the start and end points at the given position.
+ */
+export declare const at: (position: number) => Range;
+/**
+ * Returns a new `Range` with the given start point and length.
+ */
+export declare const withLength: (start: number, len: number) => Range;
+/**
+ * Returns a range with the start and end points shifted by the given distance.
+ */
+export declare const add: (distance: number, range: Range) => Range;
+/**
+ * Returns a range such that `range` is constrained to the start and end points
+ * of `to`. The function will try to maintain the length of the range, but will
+ * shrink the range if its length is greater than `to`.
+ */
+export declare const constrain: (range: Range, to: Range) => Range;
+/**
+ * Checks if the given number or range is contained within another range.
+ */
+export declare const contains: (numOrRange: number | Range, range: Range) => boolean;
+/**
+ * Returns a range that represents the overlap between `other` and `range`. If
+ * the two ranges do not intersect, then `undefined` is returned.
+ * @param other
+ * @param range
+ */
+export declare const intersection: (other: Range, range: Range) => Range | undefined;
+/**
+ * Returns `true` if `other` intersects with `range`.
+ */
+export declare const intersects: (other: Range, range: Range) => boolean;
+/**
+ * Checks if a range has the same starting point as another range.
+ */
+export declare const isAt: (other: Range, range: Range) => boolean;
+/**
+ * Returns `true` if a range's start point is after the starting point of
+ * another range.
+ */
+export declare const isAfter: (other: Range, range: Range) => boolean;
+/**
+ * Returns `true` if a range start at or is after another range.
+ */
+export declare const isAtOrAfter: (other: Range, range: Range) => boolean;
+/**
+ * Returns `true` if a range's starting point is before another range's starting
+ * point.
+ */
+export declare const isBefore: (other: Range, range: Range) => boolean;
+/**
+ * Returns `true` if a range's starting point is at or before another range's
+ * starting point.
+ */
+export declare const isAtOrBefore: (other: Range, range: Range) => boolean;
+/**
+ * Returns the length of a range.
+ */
+export declare const length: (range: Range) => number;
+/**
+ * Returns a `Range` with its start and end points subtracted by the given
+ * distance.
+ */
+export declare const subtract: (distance: number, range: Range) => Range;
+/**
+ * Adjusts either the start or end position of a range so that its contained
+ * within another range. Unlike `constrain`, this will not attempt to retain
+ * the range's length.
+ *
+ * If `other` does not intersect with `to`, then the range cannot be truncated
+ * and `undefined` is returned.
+ */
+export declare const truncate: (other: Range, to: Range) => Range | undefined;

package/dist/sets.d.ts

@@ -1 +1 @@
-export declare function diffSet<T>(a: Set<T>, b: Set<T>): Set<T>;
+export declare function diffSet<T>(a: Set<T>, b: Set<T>): Set<T>;

package/dist/sort.d.ts

@@ -1,21 +1,21 @@
-/**
- * A `Comparator` defines a function that computes the order of two values.
- */
-export declare type Comparator<T> = (a: T, b: T) => number;
-/**
- * A comparator that sorts a number or string in ascending order.
- */
-export declare const asc: (a: number | string, b: number | string) => number;
-/**
- * A comparator that sorts a number or string in descending order.
- */
-export declare const desc: (a: number | string, b: number | string) => number;
-/**
- * A comparator that reverses the sort order of another comparator.
- */
-export declare const reverse: <T>(comparator: Comparator<T>) => Comparator<T>;
-/**
- * A comparator that plucks the first element of an array and passes that value
- * to the given comparator for sorting.
- */
-export declare const head: <T>(comparator: Comparator<T>) => Comparator<T[]>;
+/**
+ * A `Comparator` defines a function that computes the order of two values.
+ */
+export type Comparator<T> = (a: T, b: T) => number;
+/**
+ * A comparator that sorts a number or string in ascending order.
+ */
+export declare const asc: (a: number | string, b: number | string) => number;
+/**
+ * A comparator that sorts a number or string in descending order.
+ */
+export declare const desc: (a: number | string, b: number | string) => number;
+/**
+ * A comparator that reverses the sort order of another comparator.
+ */
+export declare const reverse: <T>(comparator: Comparator<T>) => Comparator<T>;
+/**
+ * A comparator that plucks the first element of an array and passes that value
+ * to the given comparator for sorting.
+ */
+export declare const head: <T>(comparator: Comparator<T>) => Comparator<T[]>;

package/dist/strings.d.ts

@@ -1,3 +1,3 @@
-export declare function trimStart(str: string): string;
-export declare function trimEnd(str: string): string;
-export declare function trim(str: string): string;
+export declare function trimStart(str: string): string;
+export declare function trimEnd(str: string): string;
+export declare function trim(str: string): string;

package/dist/uri.d.ts

@@ -1,56 +1,56 @@
-/**
- * A type that represents a Uniform Resource Identifier (URI).
- */
-export interface Uri {
-    scheme?: string;
-    authority?: string;
-    path?: string;
-    query?: string;
-    fragment?: string;
-}
-declare type QueryMap = Record<string, string>;
-declare type QueryEntry = [string, string];
-/**
- * Parses a URI string according to RFC 3986. If the URI is an empty string,
- * then an empty object is returned.
- *
- * See https://tools.ietf.org/html/rfc3986#appendix-B for parsing rules.
- *
- * @param uri The URI to parse.
- */
-export declare const parse: (uri: string) => Uri;
-/**
- * Convenience method to create a URI from a base string and add params if present
- * @param base
- * @param params
- */
-export declare const parseAndAddParams: (baseStr: string, params?: Record<string, unknown> | undefined) => Uri;
-export declare const isEqual: (a: Uri, b: Uri) => boolean;
-export declare const replacePath: (path: string, uri: Uri) => Uri;
-export declare const pathAsArray: (uri: Uri) => string[];
-export declare const appendPath: (path: string, uri: Uri) => Uri;
-export declare const addQueryString: (query: string, uri: Uri) => Uri;
-export declare const addQueryEntry: (query: QueryEntry, uri: Uri) => Uri;
-export declare const addQueryEntries: (entries: QueryEntry[], uri: Uri) => Uri;
-export declare const addQueryParams: (params: Record<string, any>, uri: Uri) => Uri;
-export declare const replaceFragment: (fragment: string, uri: Uri) => Uri;
-/**
- * Return an array of name/value pairs representing the query string of a URI.
- * The returned names and values will be URI decoded. If the query string is
- * empty, then an empty array is returned.
- *
- * @param uri A URI to return the query string for.
- */
-export declare const queryAsArray: (uri: Uri) => QueryEntry[];
-/**
- * Return a map containing a URI's query string names and their values. The
- * returned names and values will be URI decoded. If the query string contains
- * multiple instances of the same name, then the last occurrence will be used.
- *
- * If the query string is empty, an empty map is returned.
- *
- * @param uri A URI to return the query string for.
- */
-export declare const queryAsMap: (uri: Uri) => QueryMap;
-export declare const toString: (uri: Uri) => string;
-export {};
+/**
+ * A type that represents a Uniform Resource Identifier (URI).
+ */
+export interface Uri {
+    scheme?: string;
+    authority?: string;
+    path?: string;
+    query?: string;
+    fragment?: string;
+}
+type QueryMap = Record<string, string>;
+type QueryEntry = [string, string];
+/**
+ * Parses a URI string according to RFC 3986. If the URI is an empty string,
+ * then an empty object is returned.
+ *
+ * See https://tools.ietf.org/html/rfc3986#appendix-B for parsing rules.
+ *
+ * @param uri The URI to parse.
+ */
+export declare const parse: (uri: string) => Uri;
+/**
+ * Convenience method to create a URI from a base string and add params if present
+ * @param base
+ * @param params
+ */
+export declare const parseAndAddParams: (baseStr: string, params?: Record<string, unknown>) => Uri;
+export declare const isEqual: (a: Uri, b: Uri) => boolean;
+export declare const replacePath: (path: string, uri: Uri) => Uri;
+export declare const pathAsArray: (uri: Uri) => string[];
+export declare const appendPath: (path: string, uri: Uri) => Uri;
+export declare const addQueryString: (query: string, uri: Uri) => Uri;
+export declare const addQueryEntry: (query: QueryEntry, uri: Uri) => Uri;
+export declare const addQueryEntries: (entries: QueryEntry[], uri: Uri) => Uri;
+export declare const addQueryParams: (params: Record<string, any>, uri: Uri) => Uri;
+export declare const replaceFragment: (fragment: string, uri: Uri) => Uri;
+/**
+ * Return an array of name/value pairs representing the query string of a URI.
+ * The returned names and values will be URI decoded. If the query string is
+ * empty, then an empty array is returned.
+ *
+ * @param uri A URI to return the query string for.
+ */
+export declare const queryAsArray: (uri: Uri) => QueryEntry[];
+/**
+ * Return a map containing a URI's query string names and their values. The
+ * returned names and values will be URI decoded. If the query string contains
+ * multiple instances of the same name, then the last occurrence will be used.
+ *
+ * If the query string is empty, an empty map is returned.
+ *
+ * @param uri A URI to return the query string for.
+ */
+export declare const queryAsMap: (uri: Uri) => QueryMap;
+export declare const toString: (uri: Uri) => string;
+export {};

package/dist/uuid.d.ts

@@ -1,8 +1,8 @@
-export declare type UUID = string;
-export interface UUIDMsbLsb {
-    msb: string;
-    lsb: string;
-}
-export declare function create(): UUID;
-export declare function fromMsbLsb(msb: bigint | string, lsb: bigint | string): UUID;
-export declare function toMsbLsb(id: UUID): UUIDMsbLsb;
+export type UUID = string;
+export interface UUIDMsbLsb {
+    msb: string;
+    lsb: string;
+}
+export declare function create(): UUID;
+export declare function fromMsbLsb(msb: bigint | string, lsb: bigint | string): UUID;
+export declare function toMsbLsb(id: UUID): UUIDMsbLsb;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/utils",
-  "version": "0.24.5",
+  "version": "1.0.0-canary.0",
   "description": "Utility library for Viewer SDK.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
@@ -12,10 +12,19 @@
   "bugs": {
     "url": "https://github.com/Vertexvis/vertex-web-sdk/issues"
   },
-  "main": "./dist/bundle.cjs.js",
-  "module": "./dist/bundle.esm.js",
-  "typings": "./dist/index.d.ts",
-  "browser": "./dist/browser.esm.js",
+  "type": "module",
+  "main": "./dist/bundle.cjs",
+  "module": "./dist/bundle.js",
+  "types": "./dist/index.d.ts",
+  "browser": "./dist/browser.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/bundle.js",
+      "require": "./dist/bundle.cjs",
+      "default": "./dist/bundle.js"
+    }
+  },
   "publishConfig": {
     "registry": "https://registry.npmjs.org",
     "access": "public"
@@ -32,7 +41,7 @@
     "format": "yarn lint --fix",
     "lint": "eslint --ext .ts,.tsx,.js,.jsx --ignore-path ../../.gitignore .",
     "start": "jest --watch",
-    "test": "jest",
+    "test": "jest --runInBand",
     "test:ci": "yarn test:coverage",
     "test:coverage": "yarn test --coverage"
   },
@@ -42,21 +51,21 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@types/jest": "^27.5.1",
+    "@types/jest": "^29.5.14",
     "@types/uuid": "^8.3.4",
     "@vertexvis/eslint-config-vertexvis-typescript": "^0.5.0",
     "@vertexvis/jest-config-vertexvis": "^0.5.4",
-    "@vertexwebsdk/build": "0.24.5",
+    "@vertexwebsdk/build": "1.0.0-canary.0",
     "eslint": "^8.57.1",
-    "jest": "^27.5.1",
-    "jest-cli": "^27.5.1",
+    "jest": "^29.5.14",
+    "jest-cli": "^29.5.14",
     "rollup": "^2.80.0",
-    "ts-jest": "^27.1.4",
-    "tslib": "^2.1.0",
-    "typescript": "^4.5.4"
+    "ts-jest": "^29.4.9",
+    "tslib": "^2.4.0",
+    "typescript": "^5.2.0"
   },
   "peerDependencies": {
-    "tslib": ">=2.1.0"
+    "tslib": ">=2.4.0"
   },
-  "gitHead": "386c9e6d3c991c81e431e1d96a2c532d90312ec6"
+  "gitHead": "30f7f54aa881ded109ea285d2838ee49754abcfe"
 }